Spectate API

Status page components

The parts of your service a status page shows, such as "API" or "Dashboard", optionally in groups. A component's status is derived: the worst ongoing impact of an unresolved incident, then maintenance, else operational. A component can follow a monitor for its uptime history, and with monitor automation the monitor's downtime opens an incident on the page.


List components

GET
https://api.spectate.net/v1
/status-pages/{statusPage}/components

Returns the page's components by position, lowest first. position is one order for the whole page. The page shows a named group once, where its first component falls, so components of a group that are not next to each other in this list still show together.

List components › path Parameters

statusPage
​string · uuid · required

Status page ID.

List components › query Parameters

page
​integer

Page number, from 1.

Default: 1
per_page
​integer

Components per page, 1 to 100.

Default: 25

List components › Responses

Paginated set of StatusPageComponent

current_page
​integer · min: 1 · required
​StatusPageComponent[] · 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.


Add a component

POST
https://api.spectate.net/v1
/status-pages/{statusPage}/components

The component starts operational and goes last in its group unless you give a position. Without a group it goes last in the last ungrouped section, and the components after that section move down by one position. monitor_id must be a monitor of the team (422 otherwise).

Add a component › path Parameters

statusPage
​string · uuid · required

Status page ID.

Add a component › Request Body

A new component of a status page. Its status follows incidents and maintenance.
name
​string · maxLength: 255 · required

Name shown on the page

Example: API
description
​string | null

Text shown with the name; null for none

Example: Our public REST API.
group
​string | null · maxLength: 255

Group to show the component in; null for no group

Example: Backend
position
​integer · min: 0 · max: 32767

Order on the whole page, lowest first, from 0 to 32767. New components go last in their section when left out

monitor_id
​string | null · uuid

A monitor of the team whose uptime history and response times the component shows, and whose downtime opens an incident when monitor automation is on; null for none

show_latency_chart
​boolean

Show the monitor's response time chart under the component

Add a component › Responses

The new component.

A component of a status page: a part of your service visitors see the status of, optionally following a monitor.
id
​string · uuid · required

Component ID

name
​string · required

Name shown on the page

Example: API
description
​string | null · required

Text shown with the name; null for none

Example: Our public REST API.
group
​string | null · required

Group the component is shown in; null for no group

Example: Backend
position
​integer · required

Order on the whole page, lowest first. A named group shows once, where its first component falls

status
​ComponentStatus · enum · required

The status, derived and read-only: the worst ongoing impact of an unresolved incident, then under_maintenance during maintenance, else operational

operational
Working normally.
degraded_performance
Slower or less reliable than usual.
partial_outage
Down for some visitors or some functions.
major_outage
Down.
under_maintenance
In planned maintenance.
Enum values:
operational
degraded_performance
partial_outage
major_outage
under_maintenance
​required
show_latency_chart
​boolean · required

Whether the page shows the monitor's response time chart under the component

created_at
​string · date-time · required

When the component was created


Reorder components

PUT
https://api.spectate.net/v1
/status-pages/{statusPage}/components/order

Saves the order and the groups of all the page's components in one atomic change. The list must hold every component of the page exactly once (422 otherwise), up to 1000. A component's index in the list becomes its position. The call is idempotent.

The page builds its sections from this order. A named group shows once, where its first component falls. Components with group: null that follow each other show as one section without a heading, so a named group between them makes two sections.

Reorder components › path Parameters

statusPage
​string · uuid · required

Status page ID.

Reorder components › Request Body

A new order for all the components of a status page.
​StatusPageComponentOrderItem[] · required

Every component of the page exactly once, in the new order

Reorder components › Responses

No content

No data returned

Get a component

GET
https://api.spectate.net/v1
/status-pages/{statusPage}/components/{component}

Returns the component with its current status.

Get a component › path Parameters

statusPage
​string · uuid · required

Status page ID.

component
​string · uuid · required

Component ID.

Get a component › Responses

The component.

A component of a status page: a part of your service visitors see the status of, optionally following a monitor.
id
​string · uuid · required

Component ID

name
​string · required

Name shown on the page

Example: API
description
​string | null · required

Text shown with the name; null for none

Example: Our public REST API.
group
​string | null · required

Group the component is shown in; null for no group

Example: Backend
position
​integer · required

Order on the whole page, lowest first. A named group shows once, where its first component falls

status
​ComponentStatus · enum · required

The status, derived and read-only: the worst ongoing impact of an unresolved incident, then under_maintenance during maintenance, else operational

operational
Working normally.
degraded_performance
Slower or less reliable than usual.
partial_outage
Down for some visitors or some functions.
major_outage
Down.
under_maintenance
In planned maintenance.
Enum values:
operational
degraded_performance
partial_outage
major_outage
under_maintenance
​required
show_latency_chart
​boolean · required

Whether the page shows the monitor's response time chart under the component

created_at
​string · date-time · required

When the component was created


Update a component

PATCH
https://api.spectate.net/v1
/status-pages/{statusPage}/components/{component}

Changes only the fields you send. Its status can't be set: post an incident or schedule maintenance instead. monitor_id: null unlinks the monitor. If you change group without a position, the component goes last in its new section, as when you add a component.

Update a component › path Parameters

statusPage
​string · uuid · required

Status page ID.

component
​string · uuid · required

Component ID.

Update a component › Request Body

Changes to a component; fields left out keep their value. Its status follows incidents and maintenance and can't be set.
name
​string · maxLength: 255

Name shown on the page

Example: API
description
​string | null

Text shown with the name; null for none

Example: Our public REST API.
group
​string | null · maxLength: 255

Group to show the component in; null for no group

Example: Backend
position
​integer · min: 0 · max: 32767

Order on the whole page, lowest first, from 0 to 32767. New components go last in their section when left out

monitor_id
​string | null · uuid

A monitor of the team whose uptime history and response times the component shows, and whose downtime opens an incident when monitor automation is on; null for none

show_latency_chart
​boolean

Show the monitor's response time chart under the component

Update a component › Responses

The updated component.

A component of a status page: a part of your service visitors see the status of, optionally following a monitor.
id
​string · uuid · required

Component ID

name
​string · required

Name shown on the page

Example: API
description
​string | null · required

Text shown with the name; null for none

Example: Our public REST API.
group
​string | null · required

Group the component is shown in; null for no group

Example: Backend
position
​integer · required

Order on the whole page, lowest first. A named group shows once, where its first component falls

status
​ComponentStatus · enum · required

The status, derived and read-only: the worst ongoing impact of an unresolved incident, then under_maintenance during maintenance, else operational

operational
Working normally.
degraded_performance
Slower or less reliable than usual.
partial_outage
Down for some visitors or some functions.
major_outage
Down.
under_maintenance
In planned maintenance.
Enum values:
operational
degraded_performance
partial_outage
major_outage
under_maintenance
​required
show_latency_chart
​boolean · required

Whether the page shows the monitor's response time chart under the component

created_at
​string · date-time · required

When the component was created


Delete a component

DELETE
https://api.spectate.net/v1
/status-pages/{statusPage}/components/{component}

It disappears from the page, with its impact periods; incidents and maintenance that affected it stay.

Delete a component › path Parameters

statusPage
​string · uuid · required

Status page ID.

component
​string · uuid · required

Component ID.

Delete a component › Responses

No content

No data returned