Instances: getSerialPortOutput

Requires authorization

Returns the specified instance's serial port output.


HTTP request



Parameter name Value Description
Path parameters
instance string Name of the instance scoping this request.
project string Project ID for this request.
zone string The name of the zone for this request.
Optional query parameters
port integer Specifies which COM or serial port to retrieve data from. Acceptable values are 1 to 4, inclusive. (Default: 1)
start long Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "compute#serialPortOutput",
  "contents": string,
  "start": long,
  "next": long,
  "selfLink": string
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
contents string [Output Only] The contents of the console output.
start long The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
next long [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.

Send feedback about...

Compute Engine