Skip to main content
GET
/
cloud
/
v1
/
instances
/
{project_id}
/
{region_id}
/
{instance_id}
/
get_console
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
console = client.cloud.instances.get_console(
    instance_id="instance_id",
    project_id=0,
    region_id=0,
)
print(console.remote_console)
{
  "remote_console": {
    "protocol": "<string>",
    "type": "<string>",
    "url": "<string>"
  }
}

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

​
region_id
integer
required

Region ID

​
instance_id
string
required

Instance ID

Query Parameters

​
console_type
string

Console type

Response

Remote console data

​
remote_console
RemoteConsoleData · object
required

Remote console information