Skip to main content
POST
Add an API key to a site

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Body

application/json

The new key's name. Any other field is refused.

name
string
required

The name, 1 to 64 characters after trimming.

Minimum string length: 1

Response

The key was added. Store secret now.

The key just added, with its secret.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

A key just added, with its secret. The secret is never shown again.

meta
object
required

Envelope metadata present on every response.