Skip to content

Create an API key

POST
/v1/keys

Mint a new API key and return the raw key material exactly once. Subsequent list/get calls never surface it.

Authorizations

Parameters

Header Parameters

X-API-Key
Any of:
string

Request Body required

Body for POST /v1/keys.

object
allowed_origins
Array<string>
expires_in_days
Any of:
integer
>= 1 <= 365
mode

Which environment a public API key is scoped to.

string
default: live
Allowed values: live test
name
required
string
>= 1 characters <= 255 characters
scopes
required
Array<string>
>= 1 items

Responses

201

Successful Response

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string