computers.exec

POST

/v1/computers/{computerId}/sessions

curl --request POST \
  --url https://example.com/v1/computers/example/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "command": "example", "cwd": "example", "env": { "additionalProperty": "example" }, "tty": true, "rows": 1, "cols": 1, "yieldTimeMs": 1, "maxOutputBytes": 1 }'

Starts a shell command and waits up to yieldTimeMs for it. When it still runs, the answer has a session ID for more input and output. A paused Computer resumes first.

Authorizations

• token
• session

Parameters

Path Parameters

computerId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

command

required

string

>= 1 characters <= 100000 characters

cwd

string

>= 1 characters <= 4096 characters

env

object

key

additional properties

string

tty

boolean

rows

integer

>= 1 <= 1000

cols

integer

>= 1 <= 1000

yieldTimeMs

integer

>= 250 <= 30000

maxOutputBytes

integer

>= 1 <= 1048576

Example ^generated

{
  "command": "example",
  "cwd": "example",
  "env": {
    "additionalProperty": "example"
  },
  "tty": true,
  "rows": 1,
  "cols": 1,
  "yieldTimeMs": 1,
  "maxOutputBytes": 1
}

Responses

200

Success

Media typeapplication/json

object

session

required

Any of:

string

string

>= 1 characters <= 128 characters

null

null

running

required

boolean

exitCode

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

signal

required

Any of:

string

string

null

null

output

required

string

truncated

required

boolean

Example ^generated

{
  "session": "example",
  "running": true,
  "exitCode": 1,
  "signal": "example",
  "output": "example",
  "truncated": true
}

400

ComputerInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ComputerInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ComputerPathNotFound

path

required

string

object

object

_tag

required

string

Allowed values: ComputerSessionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ComputerProviderNotFound

id

required

string

object

object

_tag

required

string

Allowed values: PairingInvalid

Example

{
  "_tag": "ComputerNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: ComputerProviderInUse

id

required

string

object

object

_tag

required

string

Allowed values: ComputerConflict

version

required

integer

<= 9007199254740991

executionId

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ComputerUnsupported

feature

required

string

Allowed values: pause desktop ports stream

object

object

_tag

required

string

Allowed values: ComputerNotReady

state

required

string

Allowed values: starting running paused offline failed

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

ComputerProviderFailed | ComputerExecutionFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerProviderFailed

message

required

string

object

object

_tag

required

string

Allowed values: ComputerExecutionFailed

failure

required

object

errorId

required

string

>= 1 characters <= 128 characters

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

Example

{
  "_tag": "ComputerProviderFailed"
}

503

ComputersUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: ComputersUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}