Skip to main content
POST
/
api
/
license
/
assignLicense
Assign license
curl --request POST \
  --url https://api2.rhombussystems.com/api/license/assignLicense \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "licenseUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "licenseUsage": {
    "addOnLicenseType": "CLOUD_ARCHIVING",
    "additionalPerceptionFeatures": [
      "PEOPLE_COUNTING"
    ],
    "claimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "cloudArchiveDays": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deviceType": "BLE_TRACKER",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "firstAssignedDate": "2023-11-07T05:31:56Z",
    "license": "CLOUD_ARCHIVING",
    "licenseFamily": "CAMERA",
    "licenseToUnassignEmailState": "INITIAL_EMAIL_SUCCEEDED",
    "maxDeleteDate": "2023-11-07T05:31:56Z",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "perceptionTypes": [
      "PEOPLE_COUNTING"
    ],
    "priorClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "productCode": "<string>",
    "productType": "DEVICE",
    "state": "CLAIMED",
    "trial": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for assigning an add-on license to a device.

deviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

licenseUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for assigning an add-on license to a device.

licenseUsage
object

List of licenses available for the client organization