Get License

📘
Use the hub_url received in the registration response as your base URL.

📘
This API requires the device to authenticate, see Device Authentication.

Returns a license to add or remove.

If the Send Telemetry API response has new_licenses set to true, the device must call this API to get details on the new or updated licenses.

The API will return the next license request the device needs to process. Once the required action is completed, the device must update the server via a call to the Update License API and continue calling this API until all pending license changes are finished.

When no license changes are pending, the API will return and empty object {}

Return Data
An object with details of the license change or an empty object if no changes are pending.

Name	Type	Description	Model API Version
id	string	Unique license ID.	1.0.1+
device_id	string	ID of the device the incident is created on	1.0.7+
data	string	Device-specific encoding of license information.	1.0.1+
signature	string	Partner generated signature for license validity verification of the data field.	1.0.1+
action	string	The type of action to perform: add* - Add the new license. remove* - Remove active license. update* - Existing license info changed, update required.	1.0.1+
expires_at	datetime	Time when this license should be disabled (a string based on ISO_8601 format).	1.0.1+
current_time	datetime	Current time in UTC on the server.	1.0.1+

Return Sample

{
  "data": "device-specific license info...",
  "signature": "RSA signature...",
  "id": "xxxxxxxx-xxxx...",
  "device_id": "fbe103c8-...",
  "action": "add",
  "expires_at": "2024-05-07T23:59:59Z",
  "current_time": "2024-04-07T23:59:59Z"
}

{}