Skip to main content
GET
/
api
/
v2
/
instances
/
{instanceID}
/
consolesession
Get instance console VNC
curl --request GET \
  --url https://api.example.com/api/v2/instances/{instanceID}/consolesession \
  --header 'Authorization: Bearer <token>'
{
  "url": "https://compute.glo1.dev.nscale.com:6080/vnc_lite.html?path=%3Ftoken%3Dc64ef8be-2e90-4914-83a8-61728664b770"
}

Authorizations

​
Authorization
string
header
required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

​
instanceID
string
required

The instance ID. A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length.

Required string length: 1 - 63

Response

A console session response.

A console session response.

​
url
string
required

The URL to access the console session.