Skip to main content
POST
Issue an independently scoped API key

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito). High-risk workspace administration requires an owner or admin role and fresh MFA/passkey step-up.

Headers

X-Locus-Step-Up
string<password>

Short-lived raw MFA/passkey step-up token bound to the authenticated Cognito subject. Send it alongside the dashboard Bearer token for workspace-administrator mutations when the base session does not itself prove MFA within the last ten minutes. Never send it with a tenant secret key.

Body

application/json
kind
enum<string>
required
Available options:
secret,
publishable,
sandbox
name
string
Required string length: 1 - 100
scopes
enum<string>[]
Available options:
tenant:read,
tenant:write,
catalog:write,
credits:move,
credentials:manage,
tokens:manage,
payouts:manage,
members:manage,
widget:read
tools
object
pricing
object
expiresIn
integer
Required range: 60 <= x <= 31536000

Response

{ success, kind, key, keyMetadata } — the raw key is returned exactly once, with the stored lifecycle metadata beside it.