Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID

Example:

1

region_id
integer
required

Region ID

Example:

1

instance_id
string<uuid4>
required

Instance ID

Example:

"faab46fd-26fd-4321-9876-abcdef012345"

Query Parameters

console_type
enum<string>

Console type

Available options:
novnc,
serial,
spice,
vnc

Response

200 - application/json

OK

remote_console
RemoteConsoleData · object
required

Remote console information

Example: