SPspectate
Status page components

Add a component

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

post/status-pages/{statusPage}/components

Request

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

Path parameters

statusPagestring uuid required

Status page ID.

Request body

namestring required

Name shown on the page

descriptionstring nullable

Text shown with the name; null for none

groupstring nullable

Group to show the component in; null for no group

positioninteger

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

monitor_idstring uuid nullable

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_chartboolean

Show the monitor's response time chart under the component

Example request

{
  "name": "API",
  "description": "Our public REST API.",
  "group": "Backend"
}

Response

The new component.

idstring uuid required

Component ID

namestring required

Name shown on the page

descriptionstring nullable required

Text shown with the name; null for none

groupstring nullable required

Group the component is shown in; null for no group

positioninteger required

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

status'operational' | 'degraded_performance' | 'partial_outage' | 'major_outage' | 'under_maintenance' required

A status page component's status, derived from incidents and maintenance.

operational <br/> Working normally.
degraded_performance <br/> Slower or less reliable than usual.
partial_outage <br/> Down for some visitors or some functions.
major_outage <br/> Down.
under_maintenance <br/> In planned maintenance.
show_latency_chartboolean required

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

created_atstring date-time required

When the component was created

Example response

{
  "name": "API",
  "description": "Our public REST API.",
  "group": "Backend",
  "monitor": {
    "label": "Website"
  }
}

Changes

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