computerHooks.pollPairing

POST

/v1/hooks/computers/pairings/{pairingId}/poll

const url = 'https://example.com/v1/hooks/computers/pairings/example/poll';
const options = {method: 'POST'};

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/hooks/computers/pairings/example/poll

Tells the machine if a person approved it. Send Authorization: Bearer <secret> with the secret of the pairing.

Parameters

Path Parameters

pairingId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

Example

{
  "_tag": "Pending"
}

404

PairingInvalid

application/json

object

_tag

required

string

Allowed values: PairingInvalid

Example

{
  "_tag": "PairingInvalid"
}

503

ComputersUnavailable | RequestFailed

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ComputersUnavailable

Example

{
  "_tag": "ComputersUnavailable"
}