Skip to main content
GET
Get the instance's serial console output
Requires the IAM action compute:GetConsoleOutput. 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

max_bytes
integer
default:65536

Return at most this many bytes from the END of the transcript. A ceiling you may lower, not raise: values above the 65536-byte maximum are clamped to it.

Required range: 1 <= x <= 65536

Response

The instance's console output

output
string
required

The transcript as plain text, newlines included. Empty when the instance has not booted yet.

Example:

"[ 0.000000] Linux version 6.12.0-cloud-amd64\n[ 119.356852] cloud-init[1000]: Cloud-init v. 25.1.4 finished\n"

truncated
boolean
required

True when the transcript was longer than the requested size and its BEGINNING was dropped to fit. The end is always kept.

Example:

false