Status page incidents

Publish an update

Posts an update at published_at (default now) and moves the incident to its status. affected_components are the impacts as of then: changed impacts close and reopen, components left out are no longer affected; leave the field out to keep the impacts. resolved closes every open period. An update published before the incident's latest one doesn't change the impacts. Confirmed subscribers are emailed unless notify_subscribers is false. Takes the incident over from monitor automation.

post/status-pages/{statusPage}/incidents/{incident}/updates

Request

Base URL
https://api.spectate.net/v1
Auth
HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

incidentstring uuid required

Status page incident ID.

Request body

status'investigating' | 'identified' | 'monitoring' | 'resolved' required

Where an incident stands.


investigating <br/> Declared; the cause isn't known yet.
identified <br/> Acknowledged: the cause is known and someone works on it.
monitoring <br/> A fix is out; watching whether it holds.
resolved <br/> Over.

bodystring required

The message, in Markdown

published_atstring date-time nullable

When it happened, now or in the past (default now)

notify_subscribersboolean

Email confirmed subscribers about the update (default true). false changes the page without emails

Example request

{
  "body": "We found the cause and are rolling out a fix."
}

Response

The incident with the new update.

idstring uuid required

Status page incident ID

titlestring required

Title shown on the page

status'investigating' | 'identified' | 'monitoring' | 'resolved' required

Where an incident stands.


investigating <br/> Declared; the cause isn't known yet.
identified <br/> Acknowledged: the cause is known and someone works on it.
monitoring <br/> A fix is out; watching whether it holds.
resolved <br/> Over.

impact'none' | 'degraded_performance' | 'partial_outage' | 'major_outage' required

An impact on a status page, including none: how an incident or maintenance affects a component, or an incident's overall impact.


none <br/> No impact (for a component: not affected).
degraded_performance <br/> Slower or less reliable than usual.
partial_outage <br/> Down for some visitors or some functions.
major_outage <br/> Down.

incident_idstring uuid nullable required

The team's incident that publishes to it; null for none

automatedboolean required

Opened by monitor automation and still managed by it, until someone posts an update or edits its timeline

resolved_atstring date-time nullable required

When it was resolved; null while open

created_atstring date-time required

When it was created

Example response

{
  "title": "Elevated API error rates",
  "updates": [
    {
      "body": "We found the cause and are rolling out a fix."
    }
  ],
  "affected_components": [
    {
      "component": {
        "name": "API"
      }
    }
  ],
  "impacts": [
    {
      "component": {
        "name": "API"
      }
    }
  ],
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.