Skip to main content
POST
Get device code status

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Body

application/json
code
string
required

The device code.

Example:

"GRID-AGENT-X7K9-M2P4"

Response

Successful operation

code
string
required

The device code.

Example:

"GRID-AGENT-X7K9-M2P4"

status
enum<string>
required

The current status of the device code.

  • PENDING: The code is active and has not been redeemed.
  • REDEEMED: The code was successfully redeemed.
  • EXPIRED: The code expired before it was redeemed.
  • INVALIDATED: The code was superseded or otherwise invalidated before it was redeemed.
Available options:
PENDING,
REDEEMED,
EXPIRED,
INVALIDATED
Example:

"PENDING"

redeemed
boolean
required

Whether this device code was successfully redeemed. This is false for expired or invalidated codes.

Example:

false