OnlineOrNot API v1.0.0

Use the OnlineOrNot API to manage checks, heartbeats, and status pages.

Authentication

Use an API token or OAuth access token in the Authorization header: Authorization: Bearer {access-token}.

To create an API token, open API Tokens in the dashboard and click Create token.

Public status-page summaries and oonchk.com heartbeat pings need no authentication. Each endpoint lists its required permission. EDIT includes READ for the same resource.

Scoped management routes accept session cookies when the request has no bearer token. An invalid bearer token is rejected, even if the request has a session cookie.

OAuth organization selection

API tokens belong to one organization. API tokens and single-organization OAuth grants need no organization header.

For multi-organization OAuth grants, set X-OnlineOrNot-Organisation to the public organization ID. The OAuth grant must include that organization. Replace {organisation-id} in the example with this ID.

Example for a multi-organization OAuth grant with UPTIME_CHECKS:READ:

curl 'https://api.onlineornot.com/v1/checks' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'X-OnlineOrNot-Organisation: {organisation-id}'

Documentation

• API Reference - Full API documentation with examples
• LLM-friendly docs - Markdown documentation index for AI assistants

Totally new to OnlineOrNot? Start here.

API Base URL:

• https://api.onlineornot.com

License: BSD-3-Clause