computers.createComputer

POST

/v1/computers

const url = 'https://example.com/v1/computers';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","source":{"_tag":"Provider","provider":"example","template":"example"},"desktop":true,"pauseAfter":1,"shared":true,"commandKey":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/computers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "source": { "_tag": "Provider", "provider": "example", "template": "example" }, "desktop": true, "pauseAfter": 1, "shared": true, "commandKey": "example" }'

Accepts a command to create a Computer and returns its execution receipt. Reuse the command key after a lost reply. A connector Computer stays offline until it connects.

Authorizations

token
session

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

source

required

Any of:

object
object

object

_tag

required

string

Allowed values: Provider

provider

required

string

>= 1 characters <= 128 characters

template

required

Any of:

string
null

string

desktop

boolean

pauseAfter

Any of:

integer
null

integer

>= 60 <= 604800

shared

boolean

commandKey

required

string

>= 1 characters <= 128 characters

Responses

202

Success

application/json

object

executionId

required

string

>= 1 characters <= 128 characters

commandKey

required

string

>= 1 characters <= 128 characters

sequence

required

integer

<= 9007199254740991

Example ^generated

{
  "executionId": "example",
  "commandKey": "example",
  "sequence": 1
}

400

ComputerInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ComputerInvalid

message

required

string

Example

{
  "_tag": "ComputerInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

application/json

Any of:

object

_tag

required

string

Allowed values: ComputerNotFound

required

string

Example

{
  "_tag": "ComputerNotFound"
}

409

application/json

Any of:

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

ComputerProviderFailed | ComputerExecutionFailed

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ComputerProviderFailed

message

required

string

Example

{
  "_tag": "ComputerProviderFailed"
}

503

ComputersUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}

computers.createComputer

Authorizations

Request Bodyrequired

Responses

202

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

502

Example

503

Example

Request Body^required

Example ^generated