Full API and Integration Documentation

Authentication

Obtaining your API key

Authentication is done via an OAuth2 token provided in the StatusPage.io management console, and can be accessed via the following navigation:

  • Log in to your account at https://manage.statuspage.io/login
  • View the "Account Info" page under the Manage heading on the left
  • Click on the "API" tab

Organization API Information

Passing your API key in an authorization header

The following example authenticates you with the StatusPage.io API. Along with the Organization ID listed on the API page we can fetch your page profile.

NOTE: notice the case sensivity in the header. It's OAuth and not Oauth

curl -H "Authorization: OAuth 89a229ce1a8dbcf9ff30430fbe35eb4c0426574bca932061892cefd2138aa4b1" \
  https://api.statuspage.io/v1/pages/gytm4qzbx9t6.json

The above code will produce:

{
  "id": "gytm4qzbx9t6",
  "name": "Flying Klein Brothers",
  "subdomain": "fkb",
  "domain": "status.flyingkleinbrothers.com",
  "url": "http://www.flyingkleinbrothers.com",
  ...
  ... 
}
Passing your API key in a query param

Authentication can optionally be done via a query param using the same OAuth2 token as obtained above.

curl -H https://api.statuspage.io/v1/pages/gytm4qzbx9t6.json?api_key=89a229ce1a8dbcf9ff30430fbe35eb4c0426574bca932061892cefd2138aa4b1