Skip to main content
POST
Mint a ticket for the serial console

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

instance_id
string<uuid>
required

Instance ID

Response

A ticket for one console session

A one-shot credential for opening a serial console from a browser. Pass ticket as a query parameter on the WebSocket upgrade.

ticket
string
required

The credential. Opaque — do not parse it. Good for one instance and one minute; mint a new one per connection rather than storing it.

expires_at
string<date-time>
required
expires_in
integer
required

Seconds until it expires.

Example:

60