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>

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
  • UNDERMAINTENANCE

Possible component statuses:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Possible incident statuses:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Possible maintenance statuses:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Jump to endpoints:

Contact a human
Chat on Slack or send an email

Learn more
Check help and API docs

Community
Open pagetwitter, changes & blog

Fine print
Privacy and terms

© 2022 Instatus, Inc