Spike.sh
DashboardWebsiteHUB
Spike API docs
Spike API docs
  • Page
  • About
  • API reference
    • Incidents
      • Create
      • Get previous incidents
      • Incident context
      • Activity log
      • Triggered
      • Acknowledged
      • Assigned to user
      • Acknowledge
      • Resolve
      • Escalate
      • Priority
      • Severity
    • Services
      • Create
      • Affected
    • On calls
    • Integrations
      • Available
      • Create
      • Archive
    • Orgs
      • Members
      • Info
    • Teams
      • Get all teams
      • Get my teams
    • Oncalls
      • Am i on call
      • Upcoming shifts
    • Status page
      • All
      • Component
        • Create
      • Incidents
      • Planned maintenance
        • Upcoming
        • Create
      • Subscribers
      • Incident
        • New
  • Specification
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. API reference
  2. Status page
  3. Incident

New

PreviousIncident

Last updated 4 months ago

Was this helpful?

Create incident

post

Creates a new incident on a status page

Path parameters
statusPageIdstringRequired

Status Page ID

Header parameters
x-api-keystringRequired

API Key for authentication

Body
titlestringRequired

Incident title

descstringRequired

Incident description

severitystring ยท enumRequired

Incident severity

Possible values:
notifybooleanOptional

Whether to notify subscribers

identifiedAtTimestringOptional

Time when incident was identified (HH:mm)

identifiedAtstringOptional

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

Responses
200
Incident created successfully
401
Unauthorized
post
POST /api/status-page/{statusPageId}/incident/new HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "title": "text",
  "desc": "text",
  "severity": "operational",
  "componentStatus": [
    {
      "id": "text",
      "status": "operational"
    }
  ],
  "notify": true,
  "identifiedAtTime": "text",
  "identifiedAt": "text"
}

No content