BIG-IQ 6.0.1 Licensing - Registration Key Pools¶
Overview¶
This API is used to license BIG-IPs by referencing a registration licensed key.
Version information¶
Version : BIG-IQ 6.0.0, 6.0.1
REST Endpoint: /mgmt/cm/device/licensing/pool/regkey¶
Requests¶
GET /mgmt/cm/device/licensing/pool/regkey/licenses¶
Gets the collection of BIG-IQ licensed registration keys. These keys may be used by an administrator to license a managed or unmanaged BIG-IP.
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Returns a properties_regkey_collection of BIG-IQ licensed registration keys that make up the registration key pool.
| Name | Type | Description |
|---|---|---|
| generation | integer(int64) | An integer that will track changes made to a license registration keys pool collection object. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. optional, read-only |
| kind | string | Type information for a license registration key pool collection object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to a license registration key pool collection object. optional, read-only |
| selfLink | string | A reference link URI to a license registration key pool collection object. optional, read-only |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}¶
Returns a specific licensed pool identified by id.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
Response¶
HTTP/1.1 200 OK
Returns a properties_regkey of a license pool.
| Name | Type | Description |
|---|---|---|
| generation | integer(int64) | A integer that will track changes made to a license registration key pool object. optional, read-only |
| id | string | Unique id assigned to a license registration key pool object. optional, read-only |
| kind | string | Type information for this license registration key pool object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration key pool object. optional, read-only |
| name | string | Name of registration key pool used to activate or reactivate license devices using registration key. optional |
| selfLink | string | Reference link to license registration key pool object. optional, read-only |
| sortName | string | Sort by unique name of registration key pool used to activate or reactivate license devices using registration key. optional, read-only |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
POST /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings¶
Creates a new registration license key and adds it to the BIG-IQ license regkey pool.
Request Parameters¶
| Name | Type | Description |
|---|---|---|
| post_regkey_body | object | Input parameter list in Json format. ex. {regKey: U0151-71761-41002-45076-9552496, status: ACTIVATING_AUTOMATIC, name: RegKey1} required |
| name | string | Name of license registration key. |
| regKey | string | Registration Key |
| status | string | ACTIVATING_AUTOMATIC, ACTIVATING_MANUAL_LICENSE_TEXT_PROVIDED. Please consult SA for activating manually, additional steps may be requested for generating dossier and retrieving license txt file for POST. |
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
Response¶
HTTP/1.1 200 OK
Creates a device-level task to license the BIG-IP and adds it to the properties_regkey_offerings_collection.
| Name | Type | Description |
|---|---|---|
| generation | < object > array | A integer that will track changes made to a license registration keys properties collection object. optional, read-only |
| items | integer(int64) | Collection of license registration key objects. optional, read-only |
| kind | string | Type information for a license registration keys properties collection object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration keys collection object. optional, read-only |
| selfLink | string | A reference link URI to a license registration keys properties collection object. optional, read-only |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings¶
Gets all members (BIG-IPs) that make up the license pool identified by id/members for an endpoint URI.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
Response¶
HTTP/1.1 200 OK
Gets the properties_regkey_offerings_collection of all device level tasks to license a BIG-IP.
| Name | Type | Description |
|---|---|---|
| generation | < object > array | A integer that will track changes made to a license registration keys properties collection object. optional, read-only |
| items | integer(int64) | Collection of license registration key objects. optional, read-only |
| kind | string | Type information for a license registration keys properties collection object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration keys collection object. optional, read-only |
| selfLink | string | A reference link URI to a license registration keys properties collection object. optional, read-only |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings/{registrationKey}¶
Gets a registration key license identified by id for an endpoint URI.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
| registrationKey | string(string) | Generated registration key used when licensing BIG-IP. required |
Response¶
HTTP/1.1 200 OK
Returns a properties_offering of a license registration key.
| Name | Type | Description |
|---|---|---|
| dossier | string | The dossier is an encrypted list of key characteristics used to identify the platform. https://support.f5.com/kb/en-us/solutions/public/7000/700/sol7752.html optional |
| encryptedPrivateKey | < integer > array | Encrypted private key used for decrypt / encrypt of data. optional |
| generation | integer(int64) | A integer that will track changes made to a license registration key object. optional, read-only |
| internalPrivateKey | string | Internal private key used for encryption. optional |
| kind | string | Type information for this license registration key object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration key object. optional, read-only |
| licenseState | object | State object of license registration key. optional |
| licenseText | string | Text base string for license registration key provided during activation process. optional |
| message | string | The message provided to the user of this licensing. optional ex. Activated. |
| name | string | General name for license registration key. optional ex. License for Q0168-94118-59282-63288-2594214 |
| publicKey | < integer > array | Public key used for encryption. optional |
| regKey | string | License registration key generated. optional |
| selfLink | string | Reference link to license registration key object. optional, read-only |
| sortName | string | Sort by unique name of registration key pool used to (re) activate license devices using registration key. optional |
| status | string | License registration key status. optional ex. READY |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
POST /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings/{registrationKey}/members¶
Licenses a BIG-IP and adds it as a member of a BIG-IQ license registration key pool.
Request Parameters¶
| Name | Type | Description |
|---|---|---|
| post_regkey_members_body | Json string request body. | Input parameter list in Json format. ex. {deviceAddress: 10.44.100.25, username: admin, password: admin} required |
| deviceAddress | string | IP address of device to be licensed. optional |
| password | string | Password of device to be licensed. optional |
| username | string | Username of device to be licensed. optional |
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
| registrationKey | string | Generated registration key used when licensing BIG-IP. required |
Response¶
HTTP/1.1 200 OK
Adds a device level task to properties_regkey_members_collection to license a BIG-IP.
| Name | Type | Description |
|---|---|---|
| generation | integer(int64) | A integer that will track changes made to a license registration key for a device member collection object. optional, read-only |
| items | < object > array | Collection of license registration key member objects optional, read-only |
| kind | string | Type information for a license registration key for a device member collection object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration key device object collection object. optional, read-only |
| selfLink | string | A reference link URI to a license registration key for a device member collection object. optional, read-only |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings/{registrationKey}/members¶
Returns all members (BIG-IPs) that make up the registration key license pool identified by key.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
| registrationKey | string(string) | Generated registration key used when licensing BIG-IP. required |
Response¶
HTTP/1.1 200 OK
Returns a properties_regkey_members_collection of all members (BIG-IPs) that make up the registration key license pool identified by key for an endpoint URI.
| Name | Type | Description |
|---|---|---|
| generation | integer(int64) | A integer that will track changes made to a license registration key for a device member collection object. optional, read-only |
| items | < object > array | Collection of license registration key member objects optional, read-only |
| kind | string | Type information for a license registration key for a device member collection object. optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration key device object collection object. optional, read-only |
| selfLink | string | A reference link URI to a license registration key for a device member collection object. optional, read-only |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings/{registrationKey}/members/{memberObjectId}¶
Returns all members (BIG-IPs) that make up the license pool identified by id/members/memberObjectId.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
| registrationKey | string(string) | Generated registration key used when licensing BIG-IP. required |
| memberObjectId | string(string) | Unique id assigned to a member device licensed to a registration key pool. required |
Response¶
HTTP/1.1 200 OK
Returns a properties_regkey_member for all members (BIG-IPs) that make up the license pool identified by id/members for an endpoint URI.
| Name | Type | Description |
|---|---|---|
| auditRecordReference | object | A reference link to the license audit object. Will provide audit logs id, regKey, offering, machineId, address, hostname, type, grantDateTime, status. optional |
| link | string | Reference link to audit record for license registration key. optional |
| deviceAddress | string | Device (BIG-IP) IP address. optional |
| deviceMachineId | string | Unique device id assigned to BIG-IP that is a member of this registration key pool. optional |
| generation | integer(int64) | A integer that will track changes made to a license registration key pool memeber object. optional, read-only |
| healthCheckFailureCount | integer | Count of last check or poll for health failed. optional |
| id | string | Unique id assigned to a registration key license pool device (member) object. optional, read-only |
| kind | string | Type information for this license registration key pool member (device) object, cm:device:licensing:pool:regkey:licenses:item:offerings:regkey:members:regkeypoollicensememberstate. optional, read-only |
| lastGoodHealthCheckDateTime | string | Last date/time for device license health. 2016-11-16T21:20:49.368Z optional |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration key pool member object. optional |
| message | string | The message provided to the user of this licensing task state. ex. Device licensed. optional, read-only |
| selfLink | string | Reference link to license registration key pool member (device) object. optional, read-only |
| status | string | The status of this licensing task. optional ex INSTALLING, LICENSED. |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
DEL /mgmt/cm/device/licensing/pool/regkey/licenses/{objectId}/offerings/{registrationKey}/members/{memberObjectId}¶
Deletes a member (BIG-IP) that is part of a license pool identified by id/members/memberObjectId for an endpoint URI.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to licensed registration key pool object. required |
| registrationKey | string(string) | Generated registration key used when licensing BIG-IP. required |
| memberObjectId | string(string) | Unique id assigned to a member device licensed to a registration key pool. required |
Response¶
HTTP/1.1 200 OK
Returns a properties_regkey_member for the deleted license pool member (BIG-IPs).
| Name | Type | Description |
|---|---|---|
| auditRecordReference | object | A reference link to the license audit object. Will provide audit logs id, regKey, offering, machineId, address, hostname, type, grantDateTime, status. optional |
| link | string | Reference link to audit record for license registration key. optional |
| deviceAddress | string | Device (BIG-IP) IP address. optional |
| deviceMachineId | string | Unique device id assigned to BIG-IP that is a member of this registration key pool. optional |
| generation | integer(int64) | A integer that will track changes made to a license registration key pool memeber object. optional, read-only |
| healthCheckFailureCount | integer | Count of last check or poll for health failed. optional |
| id | string | Unique id assigned to a registration key license pool device (member) object. optional, read-only |
| kind | string | Type information for this license registration key pool member (device) object, cm:device:licensing:pool:regkey:licenses:item:offerings:regkey:members:regkeypoollicensememberstate. optional, read-only |
| lastGoodHealthCheckDateTime | string | Last date/time for device license health. 2016-11-16T21:20:49.368Z optional |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an license registration key pool member object. optional |
| message | string | The message provided to the user of this licensing task state. ex. Device licensed. optional, read-only |
| selfLink | string | Reference link to license registration key pool member (device) object. optional, read-only |
| status | string | The status of this licensing task. optional ex INSTALLING, LICENSED. |
HTTP/1.1 400
Error response “Bad Request”.
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 400 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Public URI path not registered”.
| Name | Schema | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of license registration key pool objects. Error 404 optional, read-only |
| kind | string | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| License Manager | Yes |
Examples¶
None