Status page incidents

Add an impact period

Records that the incident affected a component from started_at to ended_at (null while it goes on). Periods of one component may not overlap within the incident (422). Component status and uptime history follow. Silent, and takes the incident over from monitor automation.

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

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

component_idstring uuid required

A component of the status page

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

How badly an incident affects a component. A component's status is the worst impact it has at the moment.


degraded_performance <br/> Slower or less reliable than usual.
partial_outage <br/> Down for some visitors or some functions.
major_outage <br/> Down.

started_atstring date-time required

When it started, now or in the past

ended_atstring date-time nullable

When it ended, after started_at and not in the future; null or left out while it goes on

Response

The incident with the new period.

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.