Create API Key
Creates a new API key with the specified alias.
Keys are created with granular permissions. Pass preset for a named preset
or permissions to list them explicitly; omit both to get the API preset.
Important Security Notice:
The key_secret is only returned once at creation time. Store it securely immediately
as it cannot be retrieved again. If lost, you must delete the key and create a new one.
Key Features:
- Create API keys programmatically without UI access
- Assign meaningful aliases for key identification
- Scope a key with a named preset or an explicit list of permissions
- Optionally set an expiry with
expires_at - Keys are immediately active upon creation
Common Use Cases:
- Programmatic key provisioning for CI/CD pipelines
- Self-serve key generation for team members
- Automated key rotation workflows
- Integration with secret management systems
Required permissions: auth:keys:write. Key presets that include them: FULL. See key permissions.
Authorizations
Key on the FULL preset, or any key whose permissions include the ones this API lists. Prefix it with "Key ", e.g. Authorization: Key YOUR_API_KEY
Body
Required friendly name for the API key
1 - 255"Production Key"
Optional description of what the key is for
1000"CI deploy key for the main environment"
Named permission preset to apply. Defaults to "API" when neither preset nor permissions is given. Mutually exclusive with permissions.
FULL, AGENT, API, DEPLOY, READONLY, BILLING, COMPUTE, SERVERLESS "API"
Explicit list of permissions to grant instead of a preset. Mutually exclusive with preset.
1ISO8601 timestamp after which the key stops working
"2025-07-15T12:00:00Z"
Response
API key created successfully. Store the key_secret securely - it will not be shown again.
Response containing the newly created API key credentials. The key_secret is only returned once.
Unique identifier for the newly created API key
"abc123def456"
Secret portion of the API key. IMPORTANT: This is only returned once at creation time and cannot be retrieved again.
"sk_live_abc123..."
Full API key in the format 'key_id:key_secret'. Use this value directly for API authorization. IMPORTANT: This is only returned once at creation time and cannot be retrieved again.
"abc123def456:sk_live_abc123..."