Please don't abuse the API, and please report all feature requests and issues to hi@statuspage.io

Each API token is limited to 1 request / second as measured on a 60 second rolling window. To get this limit increased or lifted, please contact hi@statuspage.io.

It's required

In order to maintain version integrity into the future, the API is versioned. All calls currently begin with the following prefix:

https://api.statuspage.io/v1/

Wherever possible, the API seeks to implement repeatable patterns with logical, representative URLs and descriptive HTTP verbs. Below are some examples and conventions you will see throughout the documentation.

• Collections are buckets: https://api.statuspage.io/v1/pages/asdf123/incidents.json
• Elements have unique IDs: https://api.statuspage.io/v1/pages/asdf123/incidents/jklm456.json
• GET will retrieve information about a collection/element
• POST will create an element in a collection
• PATCH will update a single element
• PUT will replace a single element in a collection (rarely used)
• DELETE will destroy a single element

Information can be sent in the body as form urlencoded or JSON, but make sure the Content-Type header matches the body structure or the server gremlins will be angry.

All examples are provided in JSON format, however they can easily be converted to form encoding if required. Some examples of how to convert things are below:

// JSON
{
  "incident": {
    "name": "test incident",
    "components": ["8kbf7d35c070", "vtnh60py4yd7"]
  }
}

// Form Encoded (using curl as an example):
curl -X POST https://api.statuspage.io/v1/example \
  -d "incident[name]=test incident" \
  -d "incident[components][]=8kbf7d35c070" \
  -d "incident[components][]=vtnh60py4yd7"

Operations about status embed configs

Your page profile drives basic settings for your status page including your company name, notification preferences, and time zone.

Page access users allow you to limit people who can see your status page via a login. It also allows you to limit the components and metrics each status page visitor can see, customizing the status page for their needs.

You will need Statuspage to enable access control for your status page before these API endpoints have any effect on your status page.