Skip to content

Get commander state trace

GET
/api/v1/incidents/{incident_id}/commander
curl --request GET \
--url https://api.ultimateteam.ai/api/v1/incidents/example/commander \
--header 'X-API-Key: <X-API-Key>'

Returns the CTOIncidentCommander state machine trace for an incident.

incident_id
required
Incident Id
string

Successful Response

Media typeapplication/json
CommanderStateResponse

Response for commander state endpoint.

object
attempts
Attempts
integer
0
diagnosis
Diagnosis
object
key
additional properties
any
escalation
Any of:
object
key
additional properties
any
final_state
Final State
string
""
incident_id
Incident Id
string
""
retrospective_id
Any of:
string
runbook_attempts
Runbook Attempts
Array<object>
object
key
additional properties
any
states_visited
States Visited
Array<string>
verified
Verified
boolean
Example
{
"attempts": 0,
"final_state": "",
"incident_id": "",
"verified": false
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}