Skip to content

Get console access

GET
/dashboard/service/{id}/dedicated/console

Returns VNC console connection details for accessing the server console.

Parameters

Path Parameters

id
required
integer

The service ID of the dedicated server

Responses

200

Console connection details retrieved successfully

object
success
boolean
true
data
object
connectionId

Unique connection identifier

string
requestedPort
integer
443
websocketUrl

WebSocket URL for VNC connection

string
wss://vnc.royalehosting.net/device-123-console-a1b2c3d4
password

VNC password for authentication

string

403

Service is not active or user does not have access

object
success
boolean
error

Error message describing what went wrong

string
statusCode

HTTP status code

integer

404

Service not found

object
success
boolean
error

Error message describing what went wrong

string
statusCode

HTTP status code

integer