Skip to main content
PATCH
/
status-pages
/
{id}
/
status
Update status page status
curl --request PATCH \
  --url https://api.example.com/status-pages/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "operational",
  "message": "<string>",
  "componentIds": [
    "<string>"
  ]
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Status Page ID

Body

application/json
​
status
enum<string>
required

The new status of the status page

Available options:
operational,
degraded,
partial_outage,
major_outage,
maintenance
​
message
string

Message explaining the status change

​
componentIds
string[]

Components to update with this status change

Response

The status page status has been successfully updated.