Login
Control Plane APIIncidents
POST
/v1/incidents

Create a new incident.

Query Parameters

title?string

Operational title of the incident @example "Main SQL cluster replica lag"

state?string

Active state for impacted systems (degraded or outage) @example RUNTIME_STATE_OUTAGE

Default"RUNTIME_STATE_UNSPECIFIED"

Value in

  • "RUNTIME_STATE_UNSPECIFIED"
  • "RUNTIME_STATE_OPERATIONAL"
  • "RUNTIME_STATE_MAINTENANCE"
  • "RUNTIME_STATE_DEGRADED"
  • "RUNTIME_STATE_OUTAGE"
customerMessage?string

The customer banner message shown on consumer applications @example "We are experiencing delays in processing orders due to database lag"

internalDescription?string

Internal incident description and technical notes @example "Primary PG storage node is IOPS throttled. SRE team investigating."

applicationIds?array<string>

List of application IDs targeted by this incident

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/incidents"
{  "incident": {    "createdAt": "2019-08-24T14:15:22Z",    "customerMessage": "string",    "id": "string",    "impactedApplications": [      {        "applicationId": "string",        "applicationName": "string",        "capabilities": [          {            "id": "string",            "name": "string"          }        ]      }    ],    "internalDescription": "string",    "resolvedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "state": "RUNTIME_STATE_UNSPECIFIED",    "status": "INCIDENT_STATUS_UNSPECIFIED",    "title": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "version": "string"  }}

Add Applications To Incident POST POST

Add applications to incident.

Get Incident GET GET

Retrieve details for a specific incident.