Console
All operations require authentication.
Get console outputProduction
Get console output
Returns the serial console output (boot / system log) of the instance as text. Useful for diagnosing boot problems without opening an interactive console session. This is a read-only, synchronous call.
Use the optional length query parameter to retrieve only the last N lines (the tail) of the log. Omit it to return all available output.
Path parameters
Instance ID
Project ID
Query parameters
Number of lines to retrieve from the end of the console log. When omitted, returns all available output.
Response
Captured console log of the instance as a single text blob, typically the most recent lines of console output
Example uses instanceId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "output": "string"}
Create a remote consoleProduction
Create a remote console
Opens a remote console session to the instance and returns the connection details (a url and, depending on the protocol, an access token) for a client to connect. This is a synchronous call — no desired-state reconciliation — and the returned URL is short-lived, so request a fresh console when it expires.
Protocol and type
Choose the console via the request body:
protocol— the console transport, for exampleVNC,SPICE,SERIAL.type— the concrete console kind for that protocol, for exampleNOVNCforVNC,SERIALforSERIAL.
The instance must be in a state that supports a console, otherwise the request is rejected with ResourceInInvalidState.
Path parameters
Instance ID
Project ID
Request body (required)
Desired console protocol (see RemoteConsoleProtocolEnum: VNC, SPICE, SERIAL)
SERIALSPICEVNCDesired console display type (see RemoteConsoleTypeEnum: NOVNC, XVPVNC, SPICE_HTML5, SERIAL). It must be consistent with the chosen protocol.
NOVNCSERIALSPICE_HTML5XVPVNCResponse
Protocol of the opened console session (see RemoteConsoleProtocolEnum: VNC, SPICE, SERIAL)
SERIALSPICEVNCDisplay type of the opened console session (see RemoteConsoleTypeEnum: NOVNC, XVPVNC, SPICE_HTML5, SERIAL)
NOVNCSERIALSPICE_HTML5XVPVNCConnection URL. URL to connect to the remote console. It is short-lived and grants temporary access to the instance's console.
Example uses instanceId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "protocol": "SERIAL", "type": "NOVNC", "url": "string"}