Skip to main content
GET
Open an interactive serial console
Requires the IAM action compute:StartSerialConsole. See COMPUTE permissions for the full list, what each one covers, and an example policy.

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

Query Parameters

backlog_bytes
integer
default:32768

Replay this many bytes of already-written output before live output begins, so attaching to a quiet guest shows why it is quiet instead of an empty screen. 0 disables replay. Values above 65536 are clamped. The replay is the tail of the same recording /console/output serves; the live session is the guest's serial port. The two are separate sources, so the join is marked with a \r\n--- live ---\r\n line: everything before it is history, everything after it is happening now. A guest printing at the instant you connect may have a few bytes land on neither side of that line — a quiet guest, the case replay exists for, is replayed exactly.

Required range: 0 <= x <= 65536

Response

Switching protocols — the console session is open.