API tokens

API tokens are how you authenticate requests to the CuliPulse API. You create and manage them from Settings → API Tokens in the app.

Creating a token

1. Go to Settings → API Tokens and click Generate token.
2. Give it a name so you can recognize it later (e.g. “Status page”, “CI pipeline”).
3. Choose its access level — Read-only or Read + Write (see Scopes).
4. Optionally set an expiry (30 days, 90 days, 1 year, or never).
5. Click Generate.

The raw token is shown to you exactly once, immediately after creation — copy it somewhere safe right away. CuliPulse only stores a hash of it, so if you lose it there’s no way to retrieve it; you’ll need to revoke it and generate a new one.

Every token starts with the cpk_ prefix. The app shows a short prefix of each of your tokens (not the full value) so you can tell them apart.

Scopes

Each token has one of two access levels:

• read — can list and view monitors, incidents, notification channels, agents, and reports.
• read,write (“Read + Write”) — everything read can do, plus creating, editing, and deleting monitors and notification channels.

Pick the narrowest scope a given integration actually needs — a token that only reads data for a status page, for example, doesn’t need write access.

Revoking a token

Click Revoke next to a token in Settings → API Tokens. This takes effect immediately — any client still using that token starts getting 401 Unauthorized on its next request. Revoking can’t be undone; generate a new token if you need to replace it.

How many tokens you can have

The number of active API tokens you can keep at once depends on your plan. If you’re at your limit, revoke a token you no longer use before creating a new one, or upgrade your plan.

See also Rate limits for how many requests each token can make per minute.