Skip to main content
POST
Open the desktop of a sandbox

Authorizations

Authorization
string
header
required

An API key that starts with vms_. Make one in Settings > API keys.

Path Parameters

id
string
required
Example:

"sbx_06d8k3m7q2v9x4b1n5c0e8f2ja"

Body

application/json
mode
enum<string>

What the session shows. desktop shows the full desktop. browser shows only the Chrome window.

Available options:
desktop,
browser
Example:

"desktop"

Response

The desktop session.

id
string
required
Example:

"dsk_06d8k3m7q2v9x4b1n5c0e8f2jc"

sandboxId
string
required
Example:

"sbx_06d8k3m7q2v9x4b1n5c0e8f2ja"

mode
enum<string>
required

What the session shows. desktop shows the full desktop. browser shows only the Chrome window.

Available options:
desktop,
browser
Example:

"desktop"

url
string<uri>
required

Open this URL in a browser to see the desktop. It contains a token. Do not share it.

Example:

"https://agent-42-desktop-k3m7q2v9.vmsdev.run/?_token=vmsd_Gq3n0Yb1c2d3e4f5g6h7i8j9k0l1m2n3o4p5q6r7s8t"

expiresAt
string<date-time>
required

The URL stops working at this time if nobody opens it. A browser that opened it keeps the desktop for 12 hours.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$