OrkStageOrkStage
API referenceIncidents

POST /incidents/{id}/updates

POST /incidents/{id}/updates: OrkStage Control API v1 endpoint reference.

POST
/api/v1/incidents/{id}/updates

Authorization

headerAuthorizationBearer <token>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

id*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
status*string
Value in"INVESTIGATING""IDENTIFIED""MONITORING""RESOLVED"
message*string
Length1 <= length <= 5000
impact?string
Value in"OPERATIONAL""DEGRADED""PARTIAL_OUTAGE""MAJOR_OUTAGE""MAINTENANCE""UNKNOWN"

Response Body

curl -X POST 'http://localhost:4300/api/v1/incidents/string/updates' \  -H 'Content-Type: application/json' \  -d '{  "status": "INVESTIGATING",  "message": "string"}'
Empty
Edit on GitHub

GET /incidents/{id} GET

GET /incidents/{id}: OrkStage Control API v1 endpoint reference.

GET /healthz GET

GET /healthz: OrkStage Control API v1 endpoint reference.