instance_serial_console

Fetch instance serial console
get/v1/instances/{instance}/serial-console

Path Parameters

instance

Name or ID of the instance

Query Parameters

from_start

Character index in the serial buffer from which to read, counting the bytes output since instance start. If this is not provided, most_recent must be provided, and if this is provided, most_recent must not be provided.

max_bytes

Maximum number of bytes of buffered serial console contents to return. If the requested range runs to the end of the available buffer, the data returned will be shorter than max_bytes.

most_recent

Character index in the serial buffer from which to read, counting backward from the most recently buffered data retrieved from the instance. (See note on from_start about mutual exclusivity)

project

Name or ID of the project, only required if instance is provided as a Name

Responses

Object
data

The bytes starting from the requested offset up to either the end of the buffer or the request's max_bytes. Provided as a u8 array rather than a string, as it may not be UTF-8.

last_byte_offset

The absolute offset since boot (suitable for use as byte_offset in a subsequent request) of the last byte returned in data.