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
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.
path Parameters
statusPageStatus page ID.
query Parameters
pagePage number, from 1.
per_pageComponents per page, 1 to 100.
List components › Responses
Paginated set of StatusPageComponent
current_pagefirst_page_urlfromlast_page_urllast_pageGenerated paginator links.
next_page_urlpathBase path for paginator generated URLs.
per_pageNumber of items shown per page.
prev_page_urltoNumber of the last item in the slice.
totalTotal number of items being paginated.
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).
path Parameters
statusPageStatus page ID.
Add a component › Request Body
nameName shown on the page
descriptionText shown with the name; null for none
groupGroup to show the component in; null for no group
positionOrder on the whole page, lowest first, from 0 to 32767. New components go last in their section when left out
monitor_idA 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_chartShow the monitor's response time chart under the component
Add a component › Responses
The new component.
idComponent ID
nameName shown on the page
descriptionText shown with the name; null for none
groupGroup the component is shown in; null for no group
positionOrder on the whole page, lowest first. A named group shows once, where its first component falls
statusThe 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. |
show_latency_chartWhether the page shows the monitor's response time chart under the component
created_atWhen the component was created
Reorder components
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.
path Parameters
statusPageStatus page ID.
Reorder components › Request Body
Every component of the page exactly once, in the new order
Reorder components › Responses
No content
Get a component
Returns the component with its current status.
path Parameters
statusPageStatus page ID.
componentComponent ID.
Get a component › Responses
The component.
idComponent ID
nameName shown on the page
descriptionText shown with the name; null for none
groupGroup the component is shown in; null for no group
positionOrder on the whole page, lowest first. A named group shows once, where its first component falls
statusThe 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. |
show_latency_chartWhether the page shows the monitor's response time chart under the component
created_atWhen the component was created
Update a 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.
path Parameters
statusPageStatus page ID.
componentComponent ID.
Update a component › Request Body
nameName shown on the page
descriptionText shown with the name; null for none
groupGroup to show the component in; null for no group
positionOrder on the whole page, lowest first, from 0 to 32767. New components go last in their section when left out
monitor_idA 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_chartShow the monitor's response time chart under the component
Update a component › Responses
The updated component.
idComponent ID
nameName shown on the page
descriptionText shown with the name; null for none
groupGroup the component is shown in; null for no group
positionOrder on the whole page, lowest first. A named group shows once, where its first component falls
statusThe 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. |
show_latency_chartWhether the page shows the monitor's response time chart under the component
created_atWhen the component was created