Get Desktop Url

Get the noVNC URL for desktop access.

Args: base_url: Base URL for the noVNC server (default: http://localhost:8002)

Returns: noVNC URL if available, None otherwise

GET /api/desktop/url

Get Desktop Url

cURL

curl --request GET \
  --url https://api.example.com/api/desktop/url \
  --header 'X-Session-API-Key: <api-key>'

200

{
  "url": "<string>"
}

Authorizations

X-Session-API-Key · string · header · required

Query Parameters

base_url · string · default: http://localhost:8002

Response

200

application/json

Successful Response

Response model for Desktop URL.

url · string | null · required