Get started with Instatus API

All endpoints are under the URL https://api.instatus.com. They generally follow the REST architecture.

All requests must be encoded as JSON with the Content-Type: application/json header.

Responses from the Instatus API, including errors, are encoded as JSON as well.

Authentication

Requests to Instatus API must provide an API token through the Authorization header:

You can get your API key from User settings → Developer settings

Authorization: Bearer <API_KEY>

Get your Page ID

Your Page ID can be found in the dashboard by following these steps:

1. Go to your page tab.
2. Click the <> button in the bottom left corner to toggle code mode.
3. Click the Visit Page button.
4. Your page ID will be automatically copied to clipboard.

Errors

All API endpoints contain a code and message within the error responses.

{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}

Status Values

Possible page statuses:

• UP
• HASISSUES
• ALLUNDERMAINTENANCE
• ALLDEGRADEDPERFORMANCE
• ALLPARTIALOUTAGE
• ALLMINOROUTAGE
• ALLMAJOROUTAGE
• SOMEUNDERMAINTENANCE
• SOMEDEGRADEDPERFORMANCE
• SOMEPARTIALOUTAGE
• SOMEMINOROUTAGE
• SOMEMAJOROUTAGE
• ONEUNDERMAINTENANCE
• ONEDEGRADEDPERFORMANCE
• ONEPARTIALOUTAGE
• ONEMINOROUTAGE
• ONEMAJOROUTAGE

Possible component statuses:

• OPERATIONAL
• UNDERMAINTENANCE
• DEGRADEDPERFORMANCE
• PARTIALOUTAGE
• MAJOROUTAGE

Possible incident statuses:

• INVESTIGATING
• IDENTIFIED
• MONITORING
• RESOLVED

Possible maintenance statuses:

• NOTSTARTEDYET
• INPROGRESS
• COMPLETED

Jump to endpoints: