Create, rename and revoke API keys

Create an API key

1. Open an environment of the project and click "API keys" in the menu.
2. Click "+ Create API key".
3. Enter a name (for example, Production server; up to 100 characters) and click "Create". An empty name becomes "Default".
4. Copy the key that appears and store it in your server's configuration.
5. Click "Close".

The key is shown only once, when you create it. It cannot be shown again. Use it only on your server; never put it in a browser or app.

• Live keys start with sk_live_ and Test keys with sk_test_. A key does not work in another environment.
• Developers, Admins and Owners can create, rename and revoke API keys.

The API key list

Shows the name, the start of the key, last used and created date. Keys not used for 30 days or more are marked "Not used for 30 days".

Rename an API key

1. Open the row menu on the right.
2. Choose "Rename", enter a name and save.

• Names can be up to 100 characters. A longer name shows "Enter a key name of 100 characters or fewer." and is not saved (it is never cut short). The same applies when you create a key.
• Renames are recorded in the audit log as "API key renamed" (api_key.renamed), with the previous and new names.

Revoke an API key

1. Open the row menu on the right.
2. Choose "Revoke".
3. Click "Revoke" in the confirmation dialog.

• Calls using the key fail with 401 immediately. A revoked key cannot be restored.
• Revoked keys are removed from the list. Their name and prefix remain in the audit log.

Rotate an API key

1. Create a new API key.
2. Switch your server's configuration to the new key.
3. Check that "Last used" of the old key no longer changes.
4. Revoke the old key.

API calls are limited per key per minute (600 on Free, 3,000 with a card). See Rate limits.