Skip to main content
POST
CreateApiKey

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
name
string

string.max_bytes = 128

Minimum string length: 1
expiresAt
string<date-time>

Omitted means the key does not expire. Otherwise, at least one second must remain. Creation uses a whole-second lifetime; api_key.expires_at in the response contains the effective expiration.

Example:

"2023-01-15T01:30:15.01Z"

Response

Success

apiKey
api_key · object

Public metadata. Neither the credential nor its verifier is part of this model.

key
string

Returned only by creation; never returned by list or persisted in plaintext.