updateIncident

PATCH

/api/v1/activity/incidents/{id}

curl --request PATCH \
  --url https://example.com/api/v1/activity/incidents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "action": "acknowledge", "assignedTo": "example", "reason": "example", "notes": "example" }'

Apply an operator action to an incident; every action is appended to the incident timeline with its actor. Requires an Owner or Administrator with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

action

required

string

Allowed values: acknowledge assign note resolve ignore reopen

assignedTo

string

reason

string

notes

string

Responses

200

Incident updated

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

incidentType

required

string

Allowed values: connectivity playback storage safe-mode update

severity

required

string

Allowed values: info warning error critical

status

required

string

Allowed values: open acknowledged recovered resolved ignored

title

required

string

description

required

string

openedAt

required

string format: date-time

lastSeenAt

required

string format: date-time

recoveredAt

string format: date-time

resolvedAt

string format: date-time

acknowledgedAt

string format: date-time

acknowledgedBy

string

assignedTo

string format: uuid

assignedToName

string

primaryScreenId

string format: uuid

primaryScreenName

string

locationName

string

groupName

string

deviceModel

string

playerVersion

string

affectedScreens

required

integer

failureCode

string

probableCause

string

recoveryMode

string

resolutionReason

string

resolutionNotes

string

relatedType

string

relatedId

string

occurrenceCount

required

integer

Example

{
  "data": {
    "incidentType": "connectivity",
    "severity": "info",
    "status": "open"
  }
}

400

Incident action invalid

401

Dashboard authentication required

403

Insufficient role

404

Incident not found

422

Assignee invalid