Skip to main content

Base URL

Authentication

All API requests require a Bearer token in the Authorization header:

Creating an API key

  1. Go to Dashboard > Settings > API Keys
  2. Click Create API key
  3. Choose permissions for each resource (monitors, status pages, alert channels)
  4. Copy the key — it’s only shown once
API keys use the format larm_api_<base64-payload><crc32>.

Permissions

Each API key has a permission level per resource:
Full API access (read and write) is available on all plans, including Free.

Rate limits

Limits are per API key. Rate limit headers are included on every response:

Error format

All errors return a consistent JSON structure:

Standard error codes

The heartbeat endpoint uses token-based authentication (no API key needed). All other endpoints require an API key.