Status page incidents

Download schema

Incidents as visitors of a status page read them, with their updates. How an incident affects components is a timeline of impact periods, which drives each component's status and uptime history. Publishing an update sets the impacts as of then; you can also edit the periods directly. Monitor automation opens and resolves incidents for components that follow a monitor, until someone takes over by posting an update. The team's own incidents publish here with publishIncidentStatusPageUpdate.

List status page incidents

GET

https://api.spectate.net/v1

/status-pages/{statusPage}/incidents

Returns the page's incidents, newest first, with their updates, affected components and impact periods.

List status page incidents › path Parameters

statusPage

string · uuid · required

Status page ID.

List status page incidents › query Parameters

page

integer

Page number, from 1.

Default: 1

per_page

integer

Incidents per page, 1 to 100.

Default: 25

filter[status]

IncidentStatus · enum

Only incidents with this status.

Where an incident stands.


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

Enum values:

investigating

identified

monitoring

resolved

filter[title]

string

Case-insensitive text in the title.

List status page incidents › Responses

Paginated set of StatusPageIncident

current_page

integer · min: 1 · required

StatusPageIncident[] · required

first_page_url

string | null · required

from

integer | null · min: 1 · required

last_page_url

string | null · required

last_page

integer · min: 1 · required

object[] · required

Generated paginator links.

next_page_url

string | null · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

prev_page_url

string | null · required

to

integer | null · min: 1 · required

Number of the last item in the slice.

total

integer · min: 0 · required

Total number of items being paginated.

GET/status-pages/{statusPage}/incidents

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "current_page": 1,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "Elevated API error rates",
      "status": "investigating",
      "impact": "none",
      "incident_id": "00000000-0000-0000-0000-000000000000",
      "automated": true,
      "updates": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "status": "investigating",
          "body": "We found the cause and are rolling out a fix.",
          "published_at": "2024-08-25T15:00:00Z",
          "created_at": "2024-08-25T15:00:00Z"
        }
      ],
      "affected_components": [
        {
          "component": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "API"
          },
          "impact": "none"
        }
      ],
      "impacts": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "component": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "API"
          },
          "impact": "degraded_performance",
          "started_at": "2024-08-25T15:00:00Z",
          "ended_at": "2024-08-25T15:00:00Z",
          "duration_seconds": 0
        }
      ],
      "resolved_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "writeup": {
        "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
        "published": true,
        "published_at": "2024-08-25T15:00:00Z"
      }
    }
  ],
  "first_page_url": "first_page_url",
  "from": 1,
  "last_page_url": "last_page_url",
  "last_page": 1,
  "links": [
    {
      "url": "url",
      "label": "label",
      "active": true
    }
  ],
  "next_page_url": "next_page_url",
  "path": "path",
  "per_page": 0,
  "prev_page_url": "prev_page_url",
  "to": 1,
  "total": 0
}

json

application/json

Create a status page incident

POST

https://api.spectate.net/v1

/status-pages/{statusPage}/incidents

Opens a public incident. With a body it starts with a first update published at published_at (default now), and affected_components open impact periods from then on. Confirmed subscribers are emailed unless notify_subscribers is false. incident_id links the team's incident, so publishing from it posts here.

Create a status page incident › path Parameters

statusPage

string · uuid · required

Status page ID.

Create a status page incident › Request Body

A new public incident on a status page.

CreateStatusPageIncident

title

string · maxLength: 255 · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands


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

Enum values:

investigating

identified

monitoring

resolved

body

string | null

The first update, in Markdown. Leave out to create the incident without one

Example: We're looking into errors on the API.

published_at

string | null · date-time

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

impact

ImpactLevel · enum

The incident's own impact, used while it affects no components; otherwise it follows the components


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid

The team's incident this one is for; null for none. Publishing from that incident (publishIncidentStatusPageUpdate) then posts here

StatusPageAffectedComponentInput[]

The components it affects as of published_at, with their impact; components left out are no longer affected. Leave out to keep the impacts as they are; send [] for none. Components of the status page only

notify_subscribers

boolean

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

Create a status page incident › Responses

The new status page incident.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

POST/status-pages/{statusPage}/incidents

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "title": "Elevated API error rates",
  "status": "investigating",
  "body": "We'\''re looking into errors on the API.",
  "published_at": "2024-08-25T15:00:00Z",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "affected_components": [
    {
      "component_id": "00000000-0000-0000-0000-000000000000",
      "impact": "none"
    }
  ],
  "notify_subscribers": true
}'

Example Request Body

{
  "title": "Elevated API error rates",
  "status": "investigating",
  "body": "We're looking into errors on the API.",
  "published_at": "2024-08-25T15:00:00Z",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "affected_components": [
    {
      "component_id": "00000000-0000-0000-0000-000000000000",
      "impact": "none"
    }
  ],
  "notify_subscribers": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get a status page incident

GET

https://api.spectate.net/v1

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

Returns the incident with its updates, affected components and impact periods.

Get a status page incident › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Get a status page incident › Responses

The status page incident.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

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

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update a status page incident

PATCH

https://api.spectate.net/v1

/status-pages/{statusPage}/incidents/{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.

Update a status page incident › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Update a status page incident › Request Body

Changes to a public incident without posting an update; fields left out keep their value.

UpdateStatusPageIncident

title

string · maxLength: 255

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum

Where it stands. Changing it posts no update; resolved closes every open impact period now


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum

The incident's own impact, used while it affects no components


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

Enum values:

none

degraded_performance

partial_outage

major_outage

StatusPageAffectedComponentInput[]

The components it affects as of now, with their impact; components left out are no longer affected. Leave out to keep the impacts as they are; send [] for none. Components of the status page only

notify_subscribers

boolean

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

Update a status page incident › Responses

The updated status page incident.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

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

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "affected_components": [
    {
      "component_id": "00000000-0000-0000-0000-000000000000",
      "impact": "none"
    }
  ],
  "notify_subscribers": true
}'

Example Request Body

{
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "affected_components": [
    {
      "component_id": "00000000-0000-0000-0000-000000000000",
      "impact": "none"
    }
  ],
  "notify_subscribers": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete a status page incident

DELETE

https://api.spectate.net/v1

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

Removes it from the page with its updates and impact periods; component status and uptime history follow. Silent: subscribers aren't emailed. The team's incident it was published from is kept.

Delete a status page incident › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Delete a status page incident › Responses

No content

No data returned

Save the write-up

PUT

https://api.spectate.net/v1

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

Writes the incident's public write-up, in Markdown: what happened, why, and what changes. With published: true it shows on the public incident page; with false it's a draft only the team sees, and a published write-up is taken down. Publishing needs content (422).

Confirmed subscribers are emailed the write-up when this publishes it for the first time and notify_subscribers is true; saving a published write-up again never emails. A write-up keeps the time it was first published while you edit it.

Save the write-up › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Save the write-up › Request Body

The public write-up to save on a status page incident.

SaveStatusPageIncidentWriteup

published

boolean · required

true shows it on the public incident page; false keeps it as a draft, or takes a published write-up down

content

string | null · maxLength: 50000

The write-up, in Markdown, at most 50,000 characters. Required to publish

Example: On 26 October, card payments failed for 18 minutes after a configuration change.

notify_subscribers

boolean

Email confirmed subscribers when this publishes the write-up for the first time (default false). Edits to a published write-up are never emailed

Save the write-up › Responses

The incident with its write-up.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

PUT/status-pages/{statusPage}/incidents/{incident}/writeup

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/writeup \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
  "published": true,
  "notify_subscribers": true
}'

Example Request Body

{
  "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
  "published": true,
  "notify_subscribers": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete the write-up

DELETE

https://api.spectate.net/v1

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

Removes the incident's write-up, published or a draft. Silent: subscribers aren't emailed.

Delete the write-up › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Delete the write-up › Responses

The incident without a write-up.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

DELETE/status-pages/{statusPage}/incidents/{incident}/writeup

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/writeup \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Publish an update

POST

https://api.spectate.net/v1

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

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.

Publish an update › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Publish an update › Request Body

An update to publish on a public incident.

CreateStatusPageIncidentUpdate

status

IncidentStatus · enum · required

The incident's status with this update. resolved closes every open impact period


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

Enum values:

investigating

identified

monitoring

resolved

body

string · required

The message, in Markdown

Example: We found the cause and are rolling out a fix.

published_at

string | null · date-time

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

StatusPageAffectedComponentInput[]

notify_subscribers

boolean

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

Publish an update › Responses

The incident with the new update.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

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

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/updates \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "status": "investigating",
  "body": "We found the cause and are rolling out a fix.",
  "published_at": "2024-08-25T15:00:00Z",
  "affected_components": [
    {
      "component_id": "00000000-0000-0000-0000-000000000000",
      "impact": "none"
    }
  ],
  "notify_subscribers": true
}'

Example Request Body

{
  "status": "investigating",
  "body": "We found the cause and are rolling out a fix.",
  "published_at": "2024-08-25T15:00:00Z",
  "affected_components": [
    {
      "component_id": "00000000-0000-0000-0000-000000000000",
      "impact": "none"
    }
  ],
  "notify_subscribers": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Edit an update

PATCH

https://api.spectate.net/v1

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

Changes an update's message, status or time; fields left out keep their value. Moving published_at moves the impact changes made at the old time with it. The incident's status follows its latest update. Silent, and takes the incident over from monitor automation.

Edit an update › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

update

string · uuid · required

Update ID.

Edit an update › Request Body

Changes to an update of a public incident; fields left out keep their value.

UpdateStatusPageIncidentUpdate

status

IncidentStatus · enum

The incident's status with this update. The incident follows its latest update


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

Enum values:

investigating

identified

monitoring

resolved

body

string

The message, in Markdown

Example: We found the cause and are rolling out a fix.

published_at

string · date-time

When it happened, now or in the past. Impact periods that started or ended at the old time move with it

Edit an update › Responses

The incident with the edited update.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

PATCH/status-pages/{statusPage}/incidents/{incident}/updates/{update}

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/updates/:update \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "status": "investigating",
  "body": "We found the cause and are rolling out a fix.",
  "published_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "status": "investigating",
  "body": "We found the cause and are rolling out a fix.",
  "published_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete an update

DELETE

https://api.spectate.net/v1

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

Removes the update; the incident's status follows its latest remaining update. The impact periods stay as they are. Silent, and takes the incident over from monitor automation.

Delete an update › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

update

string · uuid · required

Update ID.

Delete an update › Responses

The incident without the update.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

DELETE/status-pages/{statusPage}/incidents/{incident}/updates/{update}

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/updates/:update \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Add an impact period

POST

https://api.spectate.net/v1

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

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.

Add an impact period › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

Add an impact period › Request Body

A period during which a public incident affected a component. Periods of one component may not overlap within the incident.

CreateStatusPageImpactPeriod

component_id

string · uuid · required

A component of the status page

impact

ComponentImpact · enum · required

How badly


`degraded_performance` Slower or less reliable than usual.
`partial_outage` Down for some visitors or some functions.
`major_outage` Down.

Enum values:

degraded_performance

partial_outage

major_outage

started_at

string · date-time · required

When it started, now or in the past

ended_at

string | null · date-time

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

Add an impact period › Responses

The incident with the new period.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

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

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/impacts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "component_id": "00000000-0000-0000-0000-000000000000",
  "impact": "degraded_performance",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "component_id": "00000000-0000-0000-0000-000000000000",
  "impact": "degraded_performance",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update an impact period

PATCH

https://api.spectate.net/v1

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

Changes only the fields you send; ended_at: null reopens the period. The same rules as adding one apply. Silent, and takes the incident over from monitor automation.

Update an impact period › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

impact

string · uuid · required

Impact period ID.

Update an impact period › Request Body

Changes to an impact period; fields left out keep their value.

UpdateStatusPageImpactPeriod

component_id

string · uuid

A component of the status page

impact

ComponentImpact · enum

How badly


`degraded_performance` Slower or less reliable than usual.
`partial_outage` Down for some visitors or some functions.
`major_outage` Down.

Enum values:

degraded_performance

partial_outage

major_outage

started_at

string · date-time

When it started, now or in the past

ended_at

string | null · date-time

When it ended, after started_at and not in the future; null reopens the period

Update an impact period › Responses

The incident with the changed period.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

PATCH/status-pages/{statusPage}/incidents/{incident}/impacts/{impact}

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/impacts/:impact \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "component_id": "00000000-0000-0000-0000-000000000000",
  "impact": "degraded_performance",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "component_id": "00000000-0000-0000-0000-000000000000",
  "impact": "degraded_performance",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete an impact period

DELETE

https://api.spectate.net/v1

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

Component status and uptime history follow. Silent, and takes the incident over from monitor automation.

Delete an impact period › path Parameters

statusPage

string · uuid · required

Status page ID.

incident

string · uuid · required

Status page incident ID.

impact

string · uuid · required

Impact period ID.

Delete an impact period › Responses

The incident without the period.

A public incident on a status page: what visitors read, separate from the team's own incident (which can publish to it). Its impact on components is a timeline of periods.

StatusPageIncident

id

string · uuid · required

Status page incident ID

title

string · required

Title shown on the page

Example: Elevated API error rates

status

IncidentStatus · enum · required

Where it stands: the status of its latest update


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

Enum values:

investigating

identified

monitoring

resolved

impact

ImpactLevel · enum · required

The worst ongoing impact of its periods (the peak once resolved), none without one. An incident that affects no components keeps the impact it was given


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

Enum values:

none

degraded_performance

partial_outage

major_outage

incident_id

string | null · uuid · required

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

automated

boolean · required

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

StatusPageIncidentUpdate[] · required

Updates, newest first

StatusPageAffectedComponent[] · required

Components it affects or affected

StatusPageImpactPeriod[] · required

The impact timeline, oldest first

resolved_at

string | null · date-time · required

When it was resolved; null while open

created_at

string · date-time · required

When it was created

required

DELETE/status-pages/{statusPage}/incidents/{incident}/impacts/{impact}

curl https://api.spectate.net/v1/status-pages/:statusPage/incidents/:incident/impacts/:impact \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "Elevated API error rates",
  "status": "investigating",
  "impact": "none",
  "incident_id": "00000000-0000-0000-0000-000000000000",
  "automated": true,
  "updates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "investigating",
      "body": "We found the cause and are rolling out a fix.",
      "published_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "affected_components": [
    {
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "none"
    }
  ],
  "impacts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "component": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "API"
      },
      "impact": "degraded_performance",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "duration_seconds": 0
    }
  ],
  "resolved_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change.",
    "published": true,
    "published_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Scheduled maintenance Status page subscribers