Skip to content

Add a manual component: one with no monitor, whose status the owner sets. It goes last in its group.

POST
/status_page/{status_page_id}/component
curl --request POST \
--url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/component \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "friendly_name": "example", "description": "example", "status": "operational", "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hidden": true }'
status_page_id
required
string format: uuid

Status page identifier

Media type application/json
object
friendly_name
required

Up to 256 characters.

string
description

One line under the name. Up to 200 characters.

string | null
status

Defaults to operational.

string
Allowed values: operational degraded down maintenance
group_id

A group on this page. Leave out for the ungrouped list.

string | null format: uuid
hidden

Keep it off the public page for now.

boolean

The new component

Media type application/json

A component on the page, as the page shows it.

object
id
required

What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.

string format: uuid
monitor_id
required

The same value as id, kept for clients that predate manual components.

string format: uuid
kind
required
string
Allowed values: http_job browser_check cron_job manual
friendly_name
required
string
description

One line shown under the name, or null.

string | null
hidden
required

A hidden component stays on the page’s list but is left off the public page.

boolean
show_uptime
required

False shows the status only, with no uptime bars or percentage. Heartbeats and manual components never show uptime.

boolean
status
One of:

The status the owner set on a manual component; null for every other kind.

string
Allowed values: operational degraded down maintenance
status_override
One of:

The override in force, or null. One past its expiry reads as null.

object
status
required

What the owner says a component is doing: a manual component’s status, or an override on any component. Stored as text (status_page_components.manual_status, *.override_status).

string
Allowed values: operational degraded down maintenance
note
string | null
expires_at

When it lapses on its own, or null to keep it until cleared.

string | null format: date-time
set_at
string | null format: date-time
Example
{
"kind": "http_job",
"status": "operational",
"status_override": {
"status": "operational"
}
}

Invalid request body, a group that is not on this page, or the page already shows 100 components

Missing or invalid authentication

Status page not found

Internal server error