Skip to content
OpenBot

computers.getComputerPairing

GET
/v1/computer-pairings/{code}
curl --request GET \
  --url https://example.com/v1/computer-pairings/example \
  --header 'Authorization: Bearer <token>'

Shows which machine a pairing code is for, so the person can check it before they approve.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
code
required
string
>= 1 characters <= 32 characters

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
code
required
string
hostname
required
string
os
required
string
arch
required
string
desktop
required
boolean
expiresAt
required
number

Example generated

{
  "code": "example",
  "hostname": "example",
  "os": "example",
  "arch": "example",
  "desktop": true,
  "expiresAt": 1
}

400

Section titled “400”

ComputerInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ComputerInvalid
message
required
string

Example 

{
  "_tag": "ComputerInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve bots.read bots.write bots.delegate bots.share triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish computers.read computers.write computers.use computer_providers.read computer_providers.write computer_providers.use models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

ComputerNotFound | ComputerProviderNotFound | PairingInvalid

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ComputerNotFound
id
required
string

Example 

{
  "_tag": "ComputerNotFound"
}

409

Section titled “409”

ComputerConflict | ComputerUnsupported | ComputerNotReady

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ComputerConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "ComputerConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

502

Section titled “502”

ComputerProviderFailed

Media typeapplication/json
object
_tag
required
string
Allowed values: ComputerProviderFailed
message
required
string

Example 

{
  "_tag": "ComputerProviderFailed"
}

503

Section titled “503”

AuthorizationUnavailable | ComputersUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}