Start or rotate the preferred managed desktop viewer session
import requests
url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/stream/start"
payload = { "view_only": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/stream/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"view_only": true
}
'{
"protocol": "<string>",
"viewer_url": "<string>",
"auth_key": "<string>",
"view_only": true,
"expires_at": "2023-11-07T05:31:56Z",
"host": "<string>",
"port": 123,
"url": "<string>",
"vnc_url": "<string>"
}Desktop
Start or rotate the preferred managed desktop viewer session
POST
/
v1
/
machines
/
{id}
/
desktop
/
stream
/
start
Start or rotate the preferred managed desktop viewer session
import requests
url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/stream/start"
payload = { "view_only": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://api.13-215-85-171.sslip.io/v1/machines/{id}/desktop/stream/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"view_only": true
}
'{
"protocol": "<string>",
"viewer_url": "<string>",
"auth_key": "<string>",
"view_only": true,
"expires_at": "2023-11-07T05:31:56Z",
"host": "<string>",
"port": 123,
"url": "<string>",
"vnc_url": "<string>"
}Authorizations
API key passed as Bearer token
Path Parameters
Machine ID (e.g. mch_a1b2c3d4)
Body
application/json
Response
201 - application/json
Managed desktop viewer session started. When raw VNC is not public, the raw host, port, and VNC URL fields may be omitted while the managed viewer URL and auth token remain available.
Public managed viewer URL. In edge mode this points to the reserved desktop-{machine_id} edge host rather than the API origin.