computers.approveComputerPairing

POST

/v1/computer-pairings/{code}/approve

curl --request POST \
  --url https://example.com/v1/computer-pairings/example/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "shared": true }'

Approves a machine. OpenBot creates a connector Computer for it, and the machine gets its token on its next poll. The Computer belongs to the caller, or to the organization when shared is true. When the same machine pairs again, OpenBot keeps its Computer and only changes the token. Only a person can approve.

Authorizations

• token
• session

Parameters

Path Parameters

code

required

string

>= 1 characters <= 32 characters

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 120 characters

shared

boolean

Example ^generated

{
  "name": "example",
  "shared": true
}

Responses

201

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

name

required

string

owner

required

Any of:

object

object

_tag

required

string

Allowed values: Member

userId

required

string

object

object

_tag

required

string

Allowed values: Organization

source

required

Any of:

object

object

_tag

required

string

Allowed values: Provider

provider

required

string

>= 1 characters <= 128 characters

template

required

Any of:

string

string

null

null

object

object

_tag

required

string

Allowed values: Connector

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

integer

>= 60 <= 604800

null

null

createdBy

required

string

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

lastActiveAt

required

Any of:

number

number

null

null

executionId

string

>= 1 characters <= 128 characters

Example

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

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