LIlightsparkdev
Agent Management

Get device code status

Changed on

Check the status of a device code. Use this to poll for agent installation completion after creating an agent.

post/agents/device-codes/status

Request

  • Base URL
    https://api.lightspark.com/grid/2025-10-13
  • URL
    https://api.lightspark.com/grid/2025-10-13/agents/device-codes/status
  • Auth
    HTTP basic

Request body

codestring required

The device code.

Example request

{
  "code": "jqzJR3AgI9OAwb_enypARw"
}

Response

Successful operation

codestring required

The device code.

status'PENDING' | 'REDEEMED' | 'EXPIRED' | 'INVALIDATED' 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.
redeemedboolean required

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

Example response

{
  "code": "jqzJR3AgI9OAwb_enypARw",
  "status": "PENDING"
}

Changes

  • d996ddfb9d2bRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 5abf2bb56bcbRevision changes
    • warning

      added the new CORRIDOR_UNDER_MAINTENANCE enum value to the response property for the response status