Skip to main content
POST
/
api
/
v1
/
status-pages
/
{id}
/
incidents
Create a status page incident (manual)
curl --request POST \
  --url https://api.devhelm.io/api/v1/status-pages/{id}/incidents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "body": "<string>",
  "affectedComponents": [
    {
      "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "scheduled": true,
  "scheduledFor": "2023-11-07T05:31:56Z",
  "scheduledUntil": "2023-11-07T05:31:56Z",
  "autoResolve": true,
  "notifySubscribers": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "statusPageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "scheduled": true,
    "autoResolve": true,
    "startedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "scheduledFor": "2023-11-07T05:31:56Z",
    "scheduledUntil": "2023-11-07T05:31:56Z",
    "incidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publishedAt": "2023-11-07T05:31:56Z",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "createdByUserId": 123,
    "postmortemBody": "<string>",
    "postmortemUrl": "<string>",
    "affectedComponents": [
      {
        "statusPageComponentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "componentName": "<string>"
      }
    ],
    "updates": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "body": "<string>",
        "notifySubscribers": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "createdByUserId": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
title
string
required

Customer-facing incident title

Maximum string length: 500
​
impact
enum<string>
required

Impact level: NONE, MINOR, MAJOR, or CRITICAL

Available options:
NONE,
MINOR,
MAJOR,
CRITICAL
​
body
string
required

Initial update body in markdown

Minimum string length: 1
​
status
enum<string> | null

Initial status (default: INVESTIGATING)

Available options:
INVESTIGATING,
IDENTIFIED,
MONITORING,
RESOLVED
​
affectedComponents
object[] | null

Component IDs affected by this incident

​
scheduled
boolean | null

Whether this is a scheduled maintenance (default: false)

​
scheduledFor
string<date-time> | null

Maintenance start time (required when scheduled=true)

​
scheduledUntil
string<date-time> | null

Maintenance end time

​
autoResolve
boolean | null

Auto-resolve at scheduledUntil (default: false)

​
notifySubscribers
boolean | null

Whether to email confirmed subscribers about this incident (default: true)

Response

Created

​
data
object
required