Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.warrn.io/llms.txt

Use this file to discover all available pages before exploring further.

Error Response Format

When a request fails, the API returns a JSON object with an error message:
{
  "message": "Alert not found with alias: my-alert-alias"
}
For OpsGenie-compatible endpoints, errors include a requestId for tracing:
{
  "message": "Failed to create alert. Please try again.",
  "took": 0.0,
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

HTTP Status Codes

CodeMeaning
200Request succeeded
201Resource created
400Bad request — invalid JSON, missing required fields, or integration disabled
401Unauthorized — missing or invalid API key
403Forbidden — API key lacks required permission, or IP not in allowlist
404Not found — alert, team, or service does not exist
422Validation error — field value out of range (e.g. invalid severity)
429Rate limit exceeded — wait and retry

Common Errors

Invalid API key

HTTP 401 Unauthorized
Check that you’re passing the key as Authorization: Bearer warrn_xxx. The key must start with warrn_.

Permission denied

HTTP 403 Forbidden
Your API key has read permission but the endpoint requires write. Create a new key with the correct permission level.

Invalid severity

HTTP 422 Unprocessable Entity
The severity field must be one of: low, medium, high, critical.