Skip to main content
POST
Create an API token

Authorizations

Authorization
string
header
required

Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.

Body

application/json
name
string
required

Trimmed; cut to 80 characters.

Minimum string length: 1
scopes
enum<string>[]
required
Minimum array length: 1
Available options:
services:read,
services:stats,
services:power,
services:rescue,
services:reinstall,
services:cancel,
snapshots:read,
snapshots:write,
catalogue:read,
orders:place,
invoices:read,
invoices:pay,
tickets:read,
tickets:write
expiresInDays
number | null

Null or omitted for a token that never expires.

Required range: 1 <= x <= 3650

Response

Token created.

success
boolean
required
data
object
required