Skip to main content
POST
Create API key

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_api_key.

name
string
required

Human-readable key name; unique among the team's non-revoked keys.

Required string length: 1 - 255
permissions
string[]
required

Unified permission list; must be ⊆ the parent key on delegation.

Maximum string length: 128
account_sids
string[] | null

Channel-account slice the key reaches (ln_ac_/em_ac_); null/omitted = all team accounts, grantable only by an issuer whose own slice is unrestricted. An empty list is refused (422).

Minimum array length: 1
Required string length: 18
Pattern: ^(ln_ac_|em_ac_)
expires_at
string | null

ISO 8601 UTC; omit = now + 3 years; null = perpetual.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required