Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Download the instance serial console log as a plain-text file
Streams the full serial console log (ttyS0 mirror) of the selected instance as a plain-text
file, as triggered by the "Download log" button on the serial log tab of the instance console page.
Each line carries the kernel-clock timestamp and message exactly as rendered in the console
([ 0.000000] Linux version …), covering boot, systemd, cloud-init and agent output. The
suggested filename is <guest-hostname>-ttyS0.log via Content-Disposition. The serial log
remains reachable even when the guest network is down, which is what makes this export useful
for boot/fstab/firewall-lockout debugging.
Validation: scopeId must be accessible to the caller (404 via ErrNotFound when unknown);
instanceId must identify an instance in that scope (404 NOT_FOUND); the instance must have a
serial console buffer — instances without any captured output return an empty file rather than
an error. No body or query inputs beyond the path.
Async & state: Synchronous read; no state change. The response is a point-in-time snapshot
of the buffer; live updates continue to flow only through the console session stream, not this
endpoint.
Errors: 401 unauthenticated; 403 caller lacks console access on the scope
(owner|admin|contributor); 404 unknown scopeId or instanceId; 500 on log retrieval failure.
Idempotency/Concurrency: Safe, cacheable; no idempotency key required. Repeated downloads
may differ only by lines appended between requests.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
instanceId*stringIdentifier of the compute instance whose serial console log is downloaded.
Plain-text serial console log file (Content-Disposition attachment, <hostname>-ttyS0.log).
response?stringtext/plainNewline-separated serial console lines with kernel-clock timestamps.
curl -X GET "https://example.com/scopes/string/compute/instances/string/console/logs/export""string"