Skip to main content

Base URL

https://app.larm.dev/api/v1

Authentication

All API requests require a Bearer token in the Authorization header:
curl https://app.larm.dev/api/v1/monitors \
  -H "Authorization: Bearer larm_api_..."

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:
ResourceLevels
Monitorsnone, read, read_write
Status pagesnone, read, read_write
Alert channelsnone, read, read_write
Free plan API keys are read-only. Pro plan keys support both read and write access.

Rate limits

OperationLimit
Read120 requests/min
Write30 requests/min
Stats30 requests/min
Limits are per API key. Rate limit headers are included on every response:
HeaderDescription
x-ratelimit-limitMaximum requests allowed in the window
x-ratelimit-remainingRequests remaining in the current window
x-ratelimit-resetUnix timestamp when the window resets
retry-afterSeconds until you can retry (only on 429)

Error format

All errors return a consistent JSON structure:
{
  "error": {
    "type": "invalid_api_key",
    "message": "The provided API key is invalid or has been revoked."
  }
}

Standard error codes

StatusTypeDescription
401invalid_api_keyMissing, invalid, or revoked API key
403insufficient_permissionsAPI key lacks the required permission
429rate_limitedToo many requests — check retry-after header
The heartbeat endpoint uses token-based authentication (no API key needed). All other endpoints require an API key.