Skip to content
Docs
Select language:English

/api/v1/tokens (POST)

POST
/api/v1/tokens
curl --request POST \
  --url https://example.com/api/v1/tokens \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "scope": "read", "locationIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "expiresAt": "2026-04-15T12:00:00Z", "confirmCrossLocation": true }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
scope
required
string
Allowed values: read write
locationIds
required
Array<string>
>= 1 items <= 100 items
expiresAt
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
confirmCrossLocation
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
warning
required
string
Allowed values: cross_location_write
Example
{
  "warning": "cross_location_write"
}

201

Section titled “201”

Default Response

Media typeapplication/json
object
token
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: personal oauth
name
required
string
scope
required
string
Allowed values: read write
locations
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
createdAt
required
string
expiresAt
required
string | null
lastUsedAt
required
string | null
revokedAt
required
string | null
revokedReason
required
Any of:
string
Allowed values: user membership_ended role_lost expired admin client_revoked account_claimed
clientName
string
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
secret
required
string
clientConfigs
required
object
claudeDesktop
required
object
url
required
string
headers
required
object
key
additional properties
string
generic
required
object
url
required
string
headers
required
object
key
additional properties
string
Example
{
  "token": {
    "kind": "personal",
    "scope": "read",
    "revokedReason": "user"
  }
}