API reference

Every authenticated request carries an Authorization: Bearer {token} header. For programmatic access, the token is an API key in the form rc_live_.... Keys are shown once when you create them and stored only as a hash afterward — if you lose one, you have to create a new key. Each key carries one or both scopes: run (execute checks) and manage (create and modify saved checks, scheduled checks, alert channels, and status pages).

API keys are workspace-scoped, so you don't need to send an X-Workspace-Id header — a key only ever acts on the workspace it was created in. The alternative to an API key is a JWT from your browser session, which the web app itself uses and which does need X-Workspace-Id to select a workspace.

curl -s https://regioncheck.io/api/regions \
  -H "Authorization: Bearer rc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Run an ad-hoc check with POST /api/check. This is the same endpoint the free, anonymous tools on the site use.

Create and list saved checks with POST /api/checks and GET /api/checks. Read, update, or delete a single saved check with GET, PUT, or DELETE /api/checks/{id}. Run a saved check with POST /api/checks/{id}/run.

Turn a saved check into a scheduled check with POST /api/checks/{id}/scheduled-check. List scheduled checks with GET /api/scheduled-checks, and read its run history with GET /api/scheduled-checks/{id}/runs.

Create and list shareable result links with POST /api/shares and GET /api/shares. Revoke one with DELETE /api/shares/{token}.

List alert channels with GET /api/alert-channels, and manage a single channel with GET, PUT, or DELETE /api/alert-channels/{id}. Status pages work the same way — list with GET /api/status-pages and manage a single page with GET, PATCH, or DELETE /api/status-pages/{id}. Status pages are a team and enterprise feature; see Plans & billing for details.

GET /api/mereturns the signed-in user and workspace context. It's JWT-only — it isn't available to API keys, since it describes the browser session itself rather than a workspace capability.