Sign in
Keys

Create API Key

Creates a new API key with the specified alias.

Requirements:

  • Authentication required via admin API key

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
  • 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
post/keys

Request body

aliasstring required

Required friendly name for the API key

Example request

{
  "alias": "Production Key"
}

Response

API key created successfully. Store the key_secret securely - it will not be shown again.

key_idstring required

Unique identifier for the newly created API key

key_secretstring required

Secret portion of the API key. IMPORTANT: This is only returned once at creation time and cannot be retrieved again.

keystring required

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.

Example response

{
  "key_id": "abc123def456",
  "key_secret": "sk_live_abc123...",
  "key": "abc123def456:sk_live_abc123..."
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.