New

Create incident

Creates a new incident on a status page

post

/api/status-page/{statusPageId}/incident/new

Path parameters

statusPageIdstringrequired

Status Page ID

Header parameters

x-api-keystringrequired

API Key for authentication

Body

titlestringrequired

Incident title

descstringrequired

Incident description

notifyboolean

Whether to notify subscribers

identifiedAtTimestring

Time when incident was identified (HH:mm)

identifiedAtstring

Date when incident was identified (DD/MM/YYYY)

severitystring · enumrequired

Incident severity

Options: operational, degraded-performance, partial-outage, critical-outage

componentStatusobject[]required

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.spike.sh/api/status-page/{statusPageId}/incident/new' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "desc": "text",
    "notify": true,
    "identifiedAtTime": "text",
    "identifiedAt": "text",
    "severity": "operational",
    "componentStatus": [
      {
        "id": "text",
        "status": "operational"
      }
    ]
  }'

200

401

200

No body

Incident created successfully