computers.listComputers

GET

/v1/computers

const url = 'https://example.com/v1/computers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/v1/computers \
  --header 'Authorization: Bearer <token>'

Lists the Computers that the caller can use: their own and the shared ones. With bot, it lists only the Computers that this Bot has the right to use.

Authorizations

token
session

Parameters

Query Parameters

bot

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

Array<object>

object

required

string

>= 1 characters <= 128 characters

name

required

string

owner

required

Any of:

object
object

object

_tag

required

string

Allowed values: Member

userId

required

string

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

state

required

string

Allowed values: starting running paused offline failed

features

required

object

pause

required

boolean

desktop

required

boolean

ports

required

boolean

pauseAfter

required

Any of:

integer
null

integer

>= 60 <= 604800

createdBy

required

string

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

lastActiveAt

required

Any of:

number
null

number

executionId

string

>= 1 characters <= 128 characters

Example

[
  {
    "owner": {
      "_tag": "Member"
    },
    "source": {
      "_tag": "Provider"
    },
    "state": "starting"
  }
]

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 | 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

ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid

application/json

Any of:

object

_tag

required

string

Allowed values: ComputerNotFound

required

string

Example

{
  "_tag": "ComputerNotFound"
}

409

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

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 | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}