API keys
API keys authenticate programmatic access to your organization — reading status data and pushing external alerts.
Creating a key
- Console → Settings → API keys.
- Create a key and copy it immediately — it's shown only once.
- Store it in a secret manager or environment variable, never in source control.
Using a key
Send the key with each request. The typical form is a bearer token:
curl -H "Authorization: Bearer $PULSE_API_KEY" \
"https://pulse.servilo.in/acme/api/ingest/incident" …
Keys are scoped to your organization. See the API overview for endpoints.
Rotating & revoking
- Rotate keys periodically and after any suspected exposure.
- Revoke a key the moment it's no longer needed or a teammate leaves.
Caution
Treat API keys like passwords. Anyone with a key can act on your organization's behalf for the endpoints it allows. Never embed a key in client-side/browser code.