API Console

Last updated: 2026-05-15

The API Console is the central place in the dashboard to manage your API keys and explore the authenticated REST API. It shows your existing keys, lets you create new ones with specific scopes, and displays the base URL for API requests.

Where to Find It

In the dashboard, open:

• Developer → API (or navigate directly to /user/api-console)

API access requires a Pro plan or above. If your plan does not include API access, you will see an upgrade prompt instead.

What the API Console Shows

• Your API keys — all currently active keys, with their names and creation dates
• Available scopes — the full list of scopes you can assign to a key
• API base URL — the base URL to use for all authenticated API requests

Creating an API Key

1. Go to the API Console (/user/api-console)
2. Click Create API Key
3. Give the key a descriptive name (e.g. ci-pipeline, zapier-integration)
4. Select the scopes this key should have access to (leave empty for full access)
5. Click Create
6. Copy the key immediately — it is shown only once and cannot be retrieved again

Keys begin with spk_.

Available Scopes

A key with no scopes selected gets full access to all endpoints.

Using an API Key

Include the key in every request using either:

Authorization: Bearer spk_...

or

X-API-Key: spk_...

See the Authenticated REST API article for the full base URL and endpoint reference.

Revoking a Key

1. In the API Console, find the key you want to revoke
2. Click Revoke
3. Confirm the action

Revocation is immediate — any requests using that key will return 401 Unauthorized.

Related

• API Keys
• Authenticated REST API
• Monitors API (Authenticated)
• Incidents API (Authenticated)