POST
Create a terminal 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
shell
string
cwd
string
cols
integer<int32>
Required range: 1 <= x <= 4096
rows
integer<int32>
Required range: 1 <= x <= 512

Response

Terminal session created.

id
string
required

Terminal session ID (tsn_...).

Pattern: ^tsn_[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}$
state
enum<string>
required
Available options:
starting,
running,
closing,
closed,
failed
created_at
string<date-time>
required
shell
string
cwd
string
cols
integer<int32>
rows
integer<int32>
closed_at
string<date-time>
exit_code
integer<int32>
close_reason
string