server

Get VNC connection details

Returns VNC connection details and remote access settings for a Cloud Server.

get/1.3/server/{uuid}/vnc_details

Request

Base URL: https://api.upcloud.com
URL: https://api.upcloud.com/1.3/server/{uuid}/vnc_details
Auth: HTTP bearer

Path parameters

uuidstring uuid required

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

Cloud Server UUID

Response

VNC connection details returned.

Example response

{
  "server": {
    "remote_access_enabled": "yes",
    "remote_access_password": "A1b2C3d4",
    "remote_access_type": "vnc",
    "state": "started",
    "vnc_host": "94.237.1.20",
    "vnc_password": "A1b2C3d4",
    "vnc_port": 5901
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.