Skip to main content
API keys authenticate requests to the Cachet API. Create a separate key for each service and grant only the permissions that service needs.

​
Creating an API key

1

Open API key settings

In the Cachet dashboard, open Settings, then Manage API Keys.
2

Create a key

Click New API Key. Enter a name that helps you identify the service that uses the key.Select an expiration date, or leave it blank for a key that never expires.Select the permissions the service needs. Leaving permissions empty grants full access.
3

Save the token

Cachet displays the token only once. If you lose it, you must create a new API key.
Copy the token and store it securely.

​
Permissions

API key permissions are called abilities. Leaving permissions empty grants full access. The available abilities for each resource are: The manage ability permits creation and updates. The delete ability permits deletion. Most read-only endpoints are public unless your API settings require authentication. Subscriber read endpoints always require the subscribers.manage ability.

​
Revoking tokens

Revoking an API key is irreversible. Services that use the key can no longer authenticate with it.
To revoke a key you no longer need, click Revoke next to the key.