Skip to main content
The API Keys service allows you to create and manage API keys for authenticating service accounts and external applications.

Overview

API keys are scoped to the current user and account. When you create a key, store it securely - the full key value is shown only once.

List API Keys

Get all API keys for the current user:
Keys are masked for security, showing only the last 4 characters:

Get an API Key

Get details for a specific API key:

Create an API Key

Create a new API key:
The response includes the full key value:
Save the key value immediately after creation. The full key is shown only once and cannot be retrieved later.

Revoke an API Key

Revoke (delete) an API key:
Revoking an API key is permanent. Any applications using this key will immediately lose access.

Using API Keys

Initialize a client with an API key:
The API key will be included in all requests via the X-API-Key header.

Complete Example

API key management component:

Best Practices

  1. Store keys securely: Use environment variables or secret management systems
  2. Use descriptive names: Name your keys to identify their purpose
  3. Rotate regularly: Create new keys and revoke old ones periodically
  4. Monitor usage: Check last_used to identify inactive keys
  5. Revoke unused keys: Remove keys that are no longer needed

Next Steps