statusio_get_status_summary
Get status summary
The current state of the status page in one call: overall status, every component and container with its status code and last update, open incidents and active/upcoming maintenance. Start here. GET /status/summary/{statuspage_id}.
Parametersstatuspage_id
statusio_list_components
List components
List the components of the status page and the containers (data centers / locations) attached to each, with ids. Component and container ids are needed to update a status or to say what an incident affects ('<component_id>-<container_id>'). GET /component/list/{statuspage_id}.
Parametersstatuspage_id
statusio_list_incidents
List incident ids
The ids of all active and resolved incidents (ids only, no details): a quick way to see which incidents exist. Fetch one with statusio_get_incident. GET /incidents/{statuspage_id}.
Parametersstatuspage_id
statusio_list_active_incidents
List active incidents
Active (unresolved) incidents with their messages and affected components. GET /incident/list/active/{statuspage_id}.
Parameterspagestatuspage_id
statusio_list_resolved_incidents
List resolved incidents
Resolved incidents (history) with their messages and affected components. GET /incident/list/resolved/{statuspage_id}.
Parameterspagestatuspage_id
statusio_get_incident
Get incident
One incident in full: components, containers, infrastructure affected and all its messages. GET /incident/{statuspage_id}/{incident_id}.
Parametersincident_idrequiredstatuspage_id
statusio_get_incident_message
Get incident message
One message (update) of an incident: text, state, status, time and the user who posted it. GET /incident/message/{statuspage_id}/{message_id}.
Parametersmessage_idrequiredstatuspage_id
statusio_list_maintenance_ids
List maintenance ids
The ids of all active, closed and upcoming maintenance events (ids only). Fetch one with statusio_get_maintenance. GET /maintenances/{statuspage_id}.
Parametersstatuspage_id
statusio_list_maintenance
List maintenance
Maintenance events in one state, with messages and affected components: pending (scheduled, not started), active (in progress) or closed (finished). GET /maintenance/list/{pending|active|closed}/{statuspage_id}.
Parameterspagestaterequiredstatuspage_id
statusio_get_maintenance
Get maintenance
One maintenance event in full, with all messages and the infrastructure affected. GET /maintenance/{statuspage_id}/{maintenance_id}.
Parametersstatuspage_idmaintenance_idrequired
statusio_get_maintenance_message
Get maintenance message
One message of a maintenance event. GET /maintenance/message/{statuspage_id}/{message_id}.
Parametersmessage_idrequiredstatuspage_id
statusio_list_subscribers
List subscribers
List the people and endpoints subscribed to the status page (email addresses, phone numbers, webhook hosts) with ids and their granular preferences. This is personal data of your subscribers. Webhook URLs are shortened to their host, because they can carry secrets. GET /subscriber/list/{statuspage_id}.
Parametersstatuspage_id
statusio_update_component_status
Update component status
WRITE: change the PUBLIC status of one component/container pair (for example to degraded_performance) without creating an incident. It changes what visitors of your status page see right away. Set it back to operational when done. Ids from statusio_list_components. POST /component/status/update.
Parametersstatusrequireddetailsrequiredcomponent_idrequiredcontainer_idrequiredstatuspage_id
statusio_create_incident
Create incident
WRITE: open a new incident on the PUBLIC status page. It is visible to every visitor immediately and sets the status of the affected components. No subscriber, Slack, Teams, IRC or Twitter notification is sent unless you switch it on (notify_*). Returns the new incident id. Say what is affected with all_infrastructure_affected or infrastructure_affected pairs. POST /incident/create.
Parametersnamerequiredstatestatusrequireddetailsrequirednotify_ircnotify_smsnotify_emailnotify_slackstatuspage_idnotify_msteamsnotify_webhookmessage_subject+3 more
statusio_update_incident
Update incident
WRITE: post a new update message on an existing incident and set its state and component status. The message is public at once. No subscriber or channel notification is sent unless you switch it on (notify_*). To close an incident use statusio_resolve_incident. POST /incident/update.
Parametersstaterequiredstatusrequireddetailsrequirednotify_ircnotify_smsincident_idrequirednotify_emailnotify_slackstatuspage_idnotify_msteamsnotify_webhookmessage_subject+1 more
statusio_resolve_incident
Resolve incident
WRITE: resolve an incident with a closing message. The affected components return to operational and the incident moves to history. No notification is sent unless you switch it on (notify_*). POST /incident/resolve.
Parametersdetailsrequirednotify_ircnotify_smsincident_idrequirednotify_emailnotify_slackstatuspage_idnotify_msteamsnotify_webhookmessage_subjectpost_to_twitter
statusio_schedule_maintenance
Schedule maintenance
WRITE: schedule a planned maintenance on the PUBLIC status page. It is visible to visitors as upcoming maintenance. Subscribers are told only if you switch on notify_now / notify_72_hr / notify_24_hr / notify_1_hr (all default off). With automation true Status.io starts and ends it by itself at the planned times. Returns the maintenance id. POST /maintenance/schedule.
Parametersendrequirednamerequiredstartrequireddetailsrequiredautomationnotify_nownotify_1_hrnotify_24_hrnotify_72_hrstatuspage_idmessage_subjectautomation_stop_text+3 more
statusio_start_maintenance
Start maintenance
WRITE: start a scheduled maintenance now; it moves from pending to active and the affected components show planned maintenance. The message is public at once. No notification is sent unless you switch it on (notify_*). POST /maintenance/start.
Parametersdetailsrequirednotify_ircnotify_smsnotify_emailnotify_slackstatuspage_idmaintenance_idrequirednotify_msteamsnotify_webhookmessage_subjectpost_to_twitter
statusio_update_maintenance
Update maintenance
WRITE: post a new status message on an active maintenance event. The message is public at once. No notification is sent unless you switch it on (notify_*). POST /maintenance/update.
Parametersdetailsrequirednotify_ircnotify_smsnotify_emailnotify_slackstatuspage_idmaintenance_idrequirednotify_msteamsnotify_webhookmessage_subjectpost_to_twitter
statusio_finish_maintenance
Finish maintenance
WRITE: finish an active maintenance event; it moves to history and the affected components return to operational. The message is public at once. No notification is sent unless you switch it on (notify_*). POST /maintenance/finish.
Parametersdetailsrequirednotify_ircnotify_smsnotify_emailnotify_slackstatuspage_idmaintenance_idrequirednotify_msteamsnotify_webhookmessage_subjectpost_to_twitter