OrkStageOrkStage
API referenceIncidents

POST /incidents

POST /incidents: OrkStage Control API v1 endpoint reference.

POST
/api/v1/incidents

Authorization

headerAuthorizationBearer <token>

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

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
tenantId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
instanceId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
title*string
Length3 <= length <= 200
impact?string
Default"DEGRADED"
Value in"OPERATIONAL""DEGRADED""PARTIAL_OUTAGE""MAJOR_OUTAGE""MAINTENANCE""UNKNOWN"
severity?string
Default"medium"
Value in"low""medium""high""critical"
message*string
Length1 <= length <= 5000
componentIds?array<>
Default[]

Response Body

curl -X POST 'http://localhost:4300/api/v1/incidents' \  -H 'Content-Type: application/json' \  -d '{  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",  "title": "string",  "message": "string"}'
Empty
Edit on GitHub

GET /incidents GET

GET /incidents: OrkStage Control API v1 endpoint reference.

GET /incidents/{id} GET

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