SPspectate
Status page incidents

Update a status page incident

Edits the incident without posting an update; fields left out keep their value. affected_components set the impacts as of now. Setting status to resolved closes every open impact period now and emails confirmed subscribers unless notify_subscribers is false; other edits are silent. Changing the status or the components takes the incident over from monitor automation.

patch/status-pages/{statusPage}/incidents/{incident}

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

titlestring

Title shown on the page

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

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'

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.
notify_subscribersboolean

Email confirmed subscribers when this resolves the incident (default true). false changes the page without emails

Example request

{
  "title": "Elevated API error rates"
}

Response

The updated status page incident.

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.