Skip to main content
Manage and publish to status pages. Before using these endpoints, you must create a status page in the incident.io dashboard (find Status Pages in the left navigation bar). You can then use the ListStatusPages endpoint to find your status page IDs, and the ShowStatusPageStructure endpoint to find component IDs and group IDs for your status page. For read-only access (listing status pages, viewing structure, incidents, and maintenance windows), any valid API key will work. For write requests (creating incidents, maintenance windows, and publishing updates), you will need an API key with the “Create status page incidents, status page maintenance windows, and publish status page updates” scope.

​
The status page object

​
id
string
required

Unique ID of this status page

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
name
string
required

The title of this status page

Example:

"Our public status page"

​
description
string

The description of this status page

Example:

"This status page is our public status page."

​
public_url
string

The public URL of this status page

Example:

"https://statuspage.incident.io/our-public-status-page"