License API
List Licenses
Licenses for Device
5min
Returns a list of licenses assigned to a device
GET
Request
Query Parameters
hardware_id
required
String
Unique hardware ID generated for the client device
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
JS
Curl
1curl --location --request GET '/api/v4/device_licenses?hardware_id=STRING' \
2--header 'Accept: application/json' \
3--header 'Date: DATE_STRING' \
4--header 'Authorization: AUTHORIZATION_STRING'
5
Responses
200
400
1[
2 {
3 "id": 1702983098133459,
4 "order_store_id": "trial_1702983098133439",
5 "license_active": true,
6 "license_enabled": true,
7 "license_type": "subscription",
8 "license_key": "H62K-C35N-BS2J-VZ13",
9 "is_trial": true,
10 "max_license_users": 1,
11 "validity_period": "2023-12-20",
12 "enable_maintenance_period": false,
13 "maintenance_period": null,
14 "allow_grace_period": false,
15 "grace_period": 0,
16 "max_activations": 1,
17 "allow_unlimited_activations": true,
18 "times_activated": 1,
19 "start_date": null,
20 "transfer_count": 1,
21 "max_transfers": 0,
22 "allow_overages": false,
23 "max_overages": 0,
24 "is_floating_cloud": true,
25 "is_floating": false,
26 "floating_timeout": 120,
27 "can_borrow": false,
28 "max_borrow_time": 0,
29 "prevent_vm": false,
30 "custom_fields": [],
31 "product_features": [
32 {
33 "id": 1702983421931584,
34 "code": "e",
35 "name": "e",
36 "feature_type": "activation",
37 "expiry_date": null,
38 "metadata": {},
39 "is_floating": false,
40 "is_floating_cloud": false
41 }
42 ],
43 "customer": {
44 "email": "trial_request",
45 "company_name": null,
46 "reference": "",
47 "phone": "",
48 "first_name": null,
49 "last_name": null,
50 "city": "",
51 "postcode": "",
52 "state": "",
53 "country": "",
54 "address": "",
55 "customer_account": null,
56 "metadata": {}
57 },
58 "product_details": {
59 "product_id": 1584723961091040,
60 "product_name": "product1",
61 "short_code": "1337",
62 "authorization_method": "license-key",
63 "metadata": {}
64 },
65 "metadata": {},
66 "is_hardware_key_auth": false,
67 "is_air_gapped": false,
68 "floating_users": 1,
69 "trial_days": 1
70 },
71 {
72 "id": 1700060342999659,
73 "order_store_id": "trial_1700060342999639",
74 "license_active": false,
75 "license_enabled": true,
76 "license_type": "subscription",
77 "license_key": "H57Y-PS8L-VX6J-WU13",
78 "is_trial": true,
79 "max_license_users": 1,
80 "validity_period": null,
81 "enable_maintenance_period": false,
82 "maintenance_period": null,
83 "allow_grace_period": false,
84 "grace_period": 0,
85 "max_activations": 1,
86 "allow_unlimited_activations": false,
87 "times_activated": 0,
88 "start_date": null,
89 "transfer_count": 0,
90 "max_transfers": 0,
91 "allow_overages": false,
92 "max_overages": 0,
93 "is_floating_cloud": true,
94 "is_floating": false,
95 "floating_timeout": 120,
96 "can_borrow": false,
97 "max_borrow_time": 0,
98 "prevent_vm": false,
99 "custom_fields": [],
100 "product_features": [
101 {
102 "id": 1700060342999669,
103 "code": "ccc",
104 "name": "ccc",
105 "feature_type": "activation",
106 "expiry_date": null,
107 "metadata": {},
108 "is_floating": false,
109 "is_floating_cloud": true,
110 "floating_timeout": 120,
111 "floating_users": 1
112 }
113 ],
114 "customer": {
115 "email": "trial_request",
116 "company_name": null,
117 "reference": "",
118 "phone": "",
119 "first_name": null,
120 "last_name": null,
121 "city": "",
122 "postcode": "",
123 "state": "",
124 "country": "",
125 "address": "",
126 "customer_account": null,
127 "metadata": {}
128 },
129 "product_details": {
130 "product_id": 1584723961091040,
131 "product_name": "product1",
132 "short_code": "1337",
133 "authorization_method": "license-key",
134 "metadata": {}
135 },
136 "metadata": {},
137 "is_hardware_key_auth": false,
138 "is_air_gapped": false,
139 "floating_users": 1,
140 "trial_days": 1
141 }
142]
TypeScript
JSON Schema
1{
2 "$schema": "https://json-schema.org/draft/2020-12/schema",
3 "type": "object",
4 "properties": {
5 "hardware_id": { "type": "string" }
6 },
7 "required": ["hardware_id"],
8 "additionalProperties": false
9}
TypeScript
JSON Schema
1{
2 "$schema": "https://json-schema.org/draft/2020-12/schema",
3 "type": "array",
4 "items": {
5 "type": "object",
6 "allOf": [
7 {
8 "oneOf": [
9 {
10 "type": "object",
11 "properties": {
12 "license_key": { "type": "string" }
13 },
14 "required": ["license_key"],
15 "additionalProperties": false
16 },
17 {
18 "type": "object",
19 "properties": {
20 "user": {
21 "type": "object",
22 "properties": {
23 "id": { "type": "number" },
24 "email": { "type": "string" },
25 "first_name": { "type": "string" },
26 "last_name": { "type": "string" },
27 "phone_number": { "type": "string" },
28 "is_initial_password": { "type": "boolean" },
29 "max_activations": { "type": "number" },
30 "allow_unlimited_activations": { "type": "boolean" },
31 "total_activations": { "type": "number" }
32 },
33 "required": ["id", "email", "first_name", "last_name", "phone_number", "is_initial_password", "max_activations", "allow_unlimited_activations", "total_activations"],
34 "additionalProperties": false
35 }
36 },
37 "required": ["user"],
38 "additionalProperties": false
39 }
40 ]
41 },
42 {
43 "type": "object",
44 "properties": {
45 "id": { "type": "number" },
46 "allow_grace_period": { "type": "boolean" },
47 "allow_overages": { "type": "boolean" },
48 "allow_unlimited_activations": { "type": "boolean" },
49 "borrowed_until": { "type": ["string", "null"] },
50 "can_borrow": { "type": "boolean" },
51 "channel": { "type": "string" },
52 "device_id": { "type": "number" },
53 "enable_maintenance_period": { "type": "boolean" },
54 "environment": { "type": "string" },
55 "eula_link": { "type": "string" },
56 "floating_timeout": { "type": "number" },
57 "grace_period": { "type": "number" },
58 "hash_md5": { "type": "string" },
59 "installation_file": { "type": "string" },
60 "is_air_gapped": { "type": "boolean" },
61 "is_borrowed": { "type": "boolean" },
62 "is_expired": { "type": "boolean" },
63 "is_floating_cloud": { "type": "boolean" },
64 "is_floating": { "type": "boolean" },
65 "is_hardware_key_auth": { "type": "boolean" },
66 "license_active": { "type": "boolean" },
67 "license_enabled": { "type": "boolean" },
68 "license_signature": { "type": "string" },
69 "license_signature_v2": { "type": "string" },
70 "offline_signature": { "type": "string" },
71 "license_type": { "type": "string" },
72 "maintenance_period": { "type": ["string", "null"] },
73 "max_activations": { "type": "number" },
74 "max_borrow_time": { "type": "number" },
75 "max_license_users": { "type": "number" },
76 "max_overages": { "type": "number" },
77 "max_transfers": { "type": "number" },
78 "order_store_id": { "type": "string" },
79 "prevent_vm": { "type": "boolean" },
80 "release_date": { "type": "string" },
81 "release_notes_link": { "type": "string" },
82 "requires_version": { "type": "string" },
83 "size": { "type": "string" },
84 "start_date": { "type": ["string", "null"] },
85 "times_activated": { "type": "number" },
86 "transfer_count": { "type": "number" },
87 "validity_period": { "type": ["string", "null"] },
88 "version": { "type": "string" },
89 "product_features": {
90 "type": "array",
91 "items": {
92 "type": "object",
93 "properties": {
94 "id": { "type": "number" },
95 "code": { "type": "string" },
96 "name": { "type": "string" },
97 "expiry_date": { "type": "string" },
98 "metadata": { "type": "object" },
99 "feature_type": { "type": "string", "enum": ["activation", "consumption"] },
100 "is_floating": { "type": "boolean" },
101 "is_floating_cloud": { "type": "boolean" },
102 "floating_users": { "type": "number" },
103 "floating_timeout": { "type": "number" },
104 "max_consumption": { "type": "number" },
105 "allow_unlimited_consumptions": { "type": "boolean" },
106 "total_consumptions": { "type": "number" },
107 "allow_overages": { "type": "number" },
108 "max_overages": { "type": "number" },
109 "reset_consumption": { "type": "boolean" },
110 "consumption_period": {
111 "type": ["string", "null"],
112 "enum": ["daily", "weekly", "monthly", "annualy", null]
113 }
114 },
115 "required": ["id", "code", "name", "expiry_date", "metadata", "feature_type", "is_floating", "is_floating_cloud"]
116 }
117 },
118 "custom_fields": {
119 "type": "array",
120 "items": {
121 "type": "object",
122 "properties": {
123 "name": { "type": "string" },
124 "data_type": { "type": "string", "enum": ["numer", "text", "date/time"] },
125 "value": { "type": "string" }
126 },
127 "required": ["name", "data_type", "value"]
128 }
129 },
130 "customer": {
131 "type": "object",
132 "properties": {
133 "email": { "type": "string" },
134 "company_name": { "type": "string" },
135 "reference": { "type": "string" },
136 "phone": { "type": "string" },
137 "first_name": { "type": "string" },
138 "last_name": { "type": "string" },
139 "city": { "type": "string" },
140 "postcode": { "type": "string" },
141 "state": { "type": "string" },
142 "country": { "type": "string" },
143 "address": { "type": "string" },
144 "customer_account": { "type": ["string", "null"] },
145 "metadata": { "type": "object" }
146 },
147 "required": ["email", "company_name", "reference", "phone", "first_name", "last_name", "city", "postcode", "state", "country", "address", "metadata"]
148 },
149 "product_details": {
150 "type": "object",
151 "properties": {
152 "product_id": { "type": "number" },
153 "product_name": { "type": "string" },
154 "short_code": { "type": "string" },
155 "authorization_method": { "type": "string", "enum": ["license-key", "user"] },
156 "metadata": { "type": "object" }
157 },
158 "required": ["product_id", "product_name", "short_code", "authorization_method", "metadata"]
159 },
160 "metadata": { "type": "object" },
161 "trial_days": { "type": "number" },
162 "floating_in_use_devices": { "type": "number" },
163 "floating_users": { "type": "number" },
164 "max_consumptions": { "type": "number" },
165 "total_consumptions": { "type": "number" },
166 "allow_unlimited_consumptions": { "type": "boolean" },
167 "reset_consumption": { "type": "boolean" },
168 "consumption_period": { "type": ["string", "null"] }
169 },
170 "required": [
171 "id",
172 "allow_grace_period",
173 "allow_overages",
174 "allow_unlimited_activations",
175 "can_borrow",
176 "channel",
177 "device_id",
178 "enable_maintenance_period",
179 "environment",
180 "eula_link",
181 "floating_timeout",
182 "grace_period",
183 "hash_md5",
184 "installation_file",
185 "is_air_gapped",
186 "is_borrowed",
187 "is_expired",
188 "is_floating_cloud",
189 "is_floating",
190 "is_hardware_key_auth",
191 "license_active",
192 "license_enabled",
193 "license_signature",
194 "license_signature_v2",
195 "offline_signature",
196 "license_type",
197 "max_activations",
198 "max_borrow_time",
199 "max_license_users",
200 "max_overages",
201 "max_transfers",
202 "order_store_id",
203 "prevent_vm",
204 "release_date",
205 "release_notes_link",
206 "requires_version",
207 "size",
208 "times_activated",
209 "transfer_count",
210 "version",
211 "product_features",
212 "custom_fields",
213 "customer",
214 "product_details",
215 "metadata"
216 ],
217 "additionalProperties": false
218 }
219 ]
220 }
221}
222
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
JSON Schema
1{
2 "$schema": "https://json-schema.org/draft/2020-12/schema",
3 "type": "object",
4 "properties": {
5 "status": { "type": "number" },
6 "code": { "type": "string" },
7 "message": { "type": "string" }
8 },
9 "required": [
10 "status",
11 "code",
12 "message"
13 ],
14 "additionalProperties": false
15}
Updated 24 Jan 2025
Did this page help you?