Assign license

Assign an add-on license to a device

POST /api/license/assignLicense

Assign license

cURL

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"
}
'

200

{
  "licenseUsage": {
    "additionalPerceptionFeatures": [],
    "claimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "cloudArchiveDays": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "firstAssignedDate": "2023-11-07T05:31:56Z",
    "maxDeleteDate": "2023-11-07T05:31:56Z",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "perceptionTypes": [],
    "priorClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "productCode": "<string>",
    "trial": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

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

Show child attributes