API Keys
Manage API keys for programmatic access to your status pages.
Creating API Keys
1
Navigate
Go to Admin → API Keys
2
Create
Click Create API Key
3
Configure
Enter name, select scopes, set expiration
4
Save
Click Create and copy the key immediately
Important: Copy your API key immediately! It will only be shown once and cannot be retrieved later.
API Key Scopes
| Scope | Allows |
|---|---|
read:statuspages | Read status pages |
write:statuspages | Create/update status pages |
read:components | Read components |
write:components | Create/update components |
read:incidents | Read incidents |
write:incidents | Create/update incidents |
read:maintenance | Read maintenance |
write:maintenance | Create/update maintenance |
Using API Keys
Include the key in the Authorization header:
curl -X GET https://status.example.com/api/v1/statuspages \
-H "Authorization: Bearer YOUR_API_KEY"Expiration Options
Never
30 days
90 days
1 year
Custom
Revoking Keys
Navigate to Admin → API Keys, find the key, click Revoke, and confirm. Revoked keys are immediately invalidated.
Best Practices
- Use minimal required scopes
- Set expiration dates
- Rotate keys periodically
- Never commit keys to code
- Revoke unused keys