API Reference
API Keys
Create, list, update, and revoke API keys for backend integrations.
Overview
API keys are intended for server-to-server use. The plaintext key value is returned only once on creation.
What You Will Learn
- Creation responses return plaintext key once.
- List and patch endpoints support lifecycle management.
- Revocation behavior differs by environment under the hood.
Implementation Checklist
- Store API keys in a secrets manager immediately after creation.
- Label keys by service purpose for easier rotation.
- Rotate and revoke compromised keys promptly.
Relevant Endpoints
POST
/v1/api-keysCreate a new API key (plaintext returned once).
GET
/v1/api-keysList active API keys.
PATCH
/v1/api-keys/{key_id}Update API key name/metadata.
DELETE
/v1/api-keys/{key_id}Revoke an API key.