POST
Create a desktop session

Authorizations

Authorization
string
header
required

An opaque BMA personal or organization bearer token.

Path Parameters

orgID
string
required

Organization ID (org_...).

Pattern: ^org_[a-z2-7]{26}$
projectID
string
required

Project ID (proj_...).

Pattern: ^proj_[a-z2-7]{26}$
machineID
string
required

Machine ID (mch_...).

Pattern: ^mch_[a-z2-7]{26}$

Body

application/json
agent_id
string
Pattern: ^agt_[a-z2-7]{26}$
read_only
boolean
default:false
lease_seconds
integer<int32>
Required range: 5 <= x <= 900
capabilities
object

Response

Desktop session created.

id
string
required

Desktop session ID (dsn_...).

Pattern: ^dsn_[a-z2-7]{26}$
org_id
string
required
Pattern: ^org_[a-z2-7]{26}$
project_id
string
required

Project ID (proj_...).

Pattern: ^proj_[a-z2-7]{26}$
machine_id
string
required

Machine ID (mch_...).

Pattern: ^mch_[a-z2-7]{26}$
owner_id
string<uuid>
required

Authenticated user or organization API key that created the session.

read_only
boolean
required
closed
boolean
required
created_at
string<date-time>
required
capabilities
object
required
control
object
required
agent_id
string
Pattern: ^agt_[a-z2-7]{26}$