Skip to main content
POST
Create API Key

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
name
string
required
Required string length: 1 - 255
project_reference
string
project_id
string
projectId
string
scopes
string[]
expires_at
string

Response

API key created successfully

id
string<uuid>
required
project_id
string<uuid> | null
required
user_id
string<uuid>
required
name
string
required
key
string
required
key_prefix
string
required
expires_at
string | null
required
created_at
string
required
scopes
string[]
required
scope
enum<string>
required

Whether the key is bound to a single project or to the whole account. An account key acts as the owning user on every project that user can reach, at whatever relation that user holds on each one, bounded by the scopes on the key itself. Unlike a project-scoped key it is not capped at PROJECT_TOKEN_MAX_RELATION, so an account key with write scope can manage API keys, including minting new ones, and one with delete scope can delete projects.

Available options:
account,
project