LIlightsparkdev
Agent Management

Regenerate a device code

Changed on

Generate a new device code for an existing agent. Use this when the original device code has expired before being redeemed, or when the agent software needs to be reinstalled. An agent has at most one unredeemed device code, so regenerating invalidates the one issued before it.

post/agents/{agentId}/device-codes

Request

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

Response

New device code generated successfully

codestring required

Device code used to install and connect the agent software: an opaque 22-character URL-safe base64 string encoding 128 random bits. It is returned only when it is issued, because Grid stores only a hash of it; if it is lost before it is redeemed, regenerate it. It can be redeemed once.

agentIdstring required

The agent this device code belongs to.

expiresAtstring date-time required

Timestamp when this device code expires. Codes expire 15 minutes after they are issued by default; Grid can configure a platform's lifetime between 1 and 60 minutes.

redeemedboolean required

Whether this device code has already been redeemed by the agent.

Example response

{
  "code": "jqzJR3AgI9OAwb_enypARw",
  "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000001",
  "expiresAt": "2025-07-22T17:32:28Z"
}

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

    • 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