How Better Uptime API works

Our API follows JSON:API specification.

API tokens are scoped per team. That means you'll get a separate API token for each of your teams.

We currently support API requests for these resources:

• ​Monitors​

• ​Monitor Groups​

• ​Heartbeats​

• ​Heartbeat Groups​

• ​Incidents​

• ​Status Pages​

• ​Status Page Sections​

• ​Status Page Resources​

Do you need help integrating the API? Let us know at [email protected].

Obtaining an API Token

To obtain the API token for your team:

• Go to Team members

• Click Configure team in the header

• Click Copy to clipboard in the Direct API Token

Authorizing requests

API requests made to Better Uptime API are authorized using a Bearer Authentication standard.

That means you'll only need to add a header with Authorization: Bearer YOUR_API_TOKEN to your requests.

Response codes

200 — Success

Everything is OK.

422 — Unprocessable entity

We can't process the changes you requested. For example, we can't update your monitor because you made an invalid request.

401 — Unauthorized

You are trying to access a resource you don't have access to.

404 — Not found

The resource you're looking for doesn't exist.

500 — Unexpected error

Oops. That's probably our bad. We get notified instantly and will resolve the issue soon.