Skip to main content
POST
Attach to a session started on one of the member's computers

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Body

application/json
computerId
string
required
Required string length: 1 - 160
workspaceId
string
required
Required string length: 1 - 240
sessionId
string
required
Required string length: 1 - 240

Response

The session is attached, or the attach is queued.

target
string
required
Allowed value: "desktop"
state
enum<string>
required
Available options:
queued,
attached
commandId
string
required
Maximum string length: 160
computerId
string
required
Maximum string length: 160
workspaceId
string
required
Required string length: 1 - 240
sessionId
string
required
Required string length: 1 - 240
expiresAt
string<date-time> | null
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$