Skip to main content
POST
/
vm
/
{vm_id}
/
vnc
Open a noVNC console session
curl --request POST \
  --url https://api.cloud.onidel.com/vm/{vm_id}/vnc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_id": "96616865-475e-4191-aba5-f89f0a4b71fe"
}
'
{
  "vnc_url": "https://console.onidel.com/vnc.html?sessionid=48e5f117-9f38-40b6-8fd9-c3ccc8f916c6&vmid=afebf42d-aced-4dd4-877b-c2aa4f887ac3",
  "expire_at": 1775193067
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vm_id
string<uuid>
required

VM UUID

Body

application/json
​
team_id
string<uuid>

Team ID. Default team will be used if not provided.

Example:

"96616865-475e-4191-aba5-f89f0a4b71fe"

Response

VNC session created successfully

​
vnc_url
string

URL to access the noVNC console in a browser

Example:

"https://console.onidel.com/vnc.html?sessionid=48e5f117-9f38-40b6-8fd9-c3ccc8f916c6&vmid=afebf42d-aced-4dd4-877b-c2aa4f887ac3"

​
expire_at
integer

Unix timestamp when the session token expires (30 seconds after creation)

Example:

1775193067