Poll an active GitHub OAuth device flow

POST

/api/v1/player-releases/github/device/poll

const url = 'https://example.com/api/v1/player-releases/github/device/poll';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"flowId":"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/api/v1/player-releases/github/device/poll \
  --header 'Content-Type: application/json' \
  --data '{ "flowId": "example" }'

Requires an authenticated dashboard user.

Request Body^required

application/json

object

flowId

required

string

Example^generated

{
  "flowId": "example"
}

Responses

200

Pending, connected, denied, or expired state

application/json

object

data

required

object

status

required

string

Allowed values: pending connected denied expired

login

string

retryAfterSeconds

integer

Example

{
  "data": {
    "status": "pending"
  }
}

410

Device flow expired or was not found

502

GitHub authorization failure

Poll an active GitHub OAuth device flow

Request Bodyrequired

Examplegenerated

Responses

200

Example

410

502

Request Body^required

Example^generated