Renew the public managed desktop viewer session

import requests

url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/viewer/session"

response = requests.post(url)

print(response.text)

curl --request POST \
  --url https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/viewer/session

{
  "machine_id": "<string>",
  "auth_key": "<string>",
  "viewer_url": "<string>",
  "ws_url": "<string>",
  "view_only": true,
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

POST

machines

{id}

desktop

viewer

session

Renew the public managed desktop viewer session

import requests

url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/viewer/session"

response = requests.post(url)

print(response.text)

curl --request POST \
  --url https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/viewer/session

{
  "machine_id": "<string>",
  "auth_key": "<string>",
  "viewer_url": "<string>",
  "ws_url": "<string>",
  "view_only": true,
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

Path Parameters

string

required

Machine ID (e.g. mch_a1b2c3d4)

Query Parameters

auth

string

required

Short-lived managed desktop viewer auth token returned by /desktop/stream/start, /desktop/stream/auth-key, or /desktop/viewer/session.

Response

Refreshed viewer session details for browser bootstrap and reconnect. The response returns a renewed auth_key, a matching viewer_url, and the current websocket bridge URL without requiring the normal API bearer key. In edge mode these URLs point at the edge-owned desktop host rather than the API origin.

machine_id

string

required

auth_key

string

required

viewer_url

string

required

Renewed public managed viewer URL for the current session. In edge mode this points to the edge-owned desktop host.

ws_url

string

required

Renewed websocket bridge URL for the current session. In edge mode this points to the edge-owned desktop host websocket path.

view_only

boolean

required

expires_at

string<date-time>

required

Get the managed desktop viewer page Get text from the guest clipboard through the managed viewer auth token

Overview

Endpoints

Renew the public managed desktop viewer session

Path Parameters

Query Parameters

Response