Detach a license from a network license pool
POST /v1.0/lm/detach
In online mode, detaches a license from a remote server and installs it locally. For this, the offline flag must be false and lmsId must be equal to the local license manager ID.
It is impossible to detach a license from a remote PC in online mode.
In offline mode, detaches a license from a remote or local server and returns a license buffer. The offline flag must be true in this case.
RAW JSON input parameters:
{
"offline" : true,
"lmsId": "14314416473658448602",
"dongleId" : 1368487351,
"durationInSec" : 3600,
"concurrentResourceToConsume" : 1,
"productFeatures": [
{
"productNumber": 16,
"featureNumber": 2
},
{
"productNumber": 4,
"featureNumber": 1
}
]
}
Returns an empty object if the offline flag is NOT set:
{
}
Returns the license in the license field if the offline flag is set:
{
"license": "av5NMggAAAAIBwAAS *** AAAAPAAAAAAA"
}
Detached license return
POST /v1.0/lm/canceldetach
Returns a license to the network license pool.
In online mode, returns a license from the local computer to the remote server. The offline flag must be false in this case. In offline mode, removes the license from the local computer and returns the license buffer. The offline flag must be true in this case.
RAW JSON input parameters:
{
"offline" : true,
"dongleId" : 1368487351
}
Returns an empty object if the offline flag is NOT set:
{
}
Returns the license in the license field if the offline flag is set:
{
"license": "av5NMggAAAAIBwAAS *** AAAAPAAAAAAA"
}
License installation
POST /v1.0/lm/install
In offline mode, installs a license buffer on the local computer.
RAW JSON input parameters:
{
"license": "av5NMggAAAAIBwAAS *** AAAAPAAAAAAA"
}
Get a list of detached licenses with products and features
GET/v1.0/lm/detached/products/features?search=text_or_value_for_search&dongle=3043211265&product=12&feature=2
Returns the licenses that have been detached from the local PC. You can search by feature number, product number, product modification number, feature name, product name, key ID, vendor public code (in numeric and text form), and the name of the computer to which the license was detached. You can filter by key ID, product number, and feature number.
deathTime field - is the time when the detached license will return to the pool
detachedFromLicenseId - is the identifier of the original license
licenseId - is the identifier of the detached license
durationInSec - is the detached license lifetime
hostName - the name of the computer where the detached license will be installed
Returns the detachedLicenses array:
{
"detachedLicenses": [
{
"deathTime": 1653667658,
"detachedFromLicenseId": "4006242369",
"detachedFromLicenseIdShort": 4006242369,
"detachedResource": 1,
"durationInSec": 60,
"hostName": "B2291-PC",
"licenseId": 956653681540574192,
"licenseIdShort": 1833675760,
"products": [
{
"dongleId": 0,
"features": [
{
"consumptionMode": 0,
"currentRunCounterValue": 0,
"detachedResource": 0,
"dongleId": 0,
"featureNumber": 4,
"flags": {
"cancelDetachRequired": false,
"expired": false,
"isDetachAllowed": false,
"isDetachable": false,
"rdpForbidden": true,
"vmForbidden": true
},
"floatingResource": 1,
"maxConcurrentResource": 1,
"maxRunCounter": 0,
"name": "test net",
"productModification": 0,
"productName": "test_detach_29",
"productNumber": 29,
"remoteMode": 3,
"reservedResource": 0,
"restOfLifeTimeDays": 0,
"sessionsCount": 0,
"validFromDate": 0,
"validUpToDate": 0,
"vendor": {
"publicCode": 1368487351,
"publicCodeText": "DEMONVK"
}
}
],
"modification": 0,
"name": "test_detach_29",
"productNumber": 29,
"vendor": {
"publicCode": 1368487351,
"publicCodeText": "DEMONVK"
}
}
],
"productsCount": 1,
"vendor": {
"publicCode": 1368487351,
"publicCodeText": "DEMONVK"
}
}
]
}
Repeated download of a detached license
POST /v1.0/lm/detached/download
Allows you to download a detached license once again.
RAW JSON input parameters:
{
"licenseId" : "956653681540574192"
}
Returns the license in the license field:
{
"license": "av5NMggAAAAIBwAAS *** AAAAPAAAAAAA"
}
Get a list of detached licenses to cancel
GET/v1.0/lm/cancelled/licenses
Returns licenses that have been detached from the local PC.
detachedFromLicenseId - ID of the original license
licenseId - ID of the detached license
Returns the cancelledLicenses array:
{
"cancelledLicenses": [
{
"detachedFromLicenseId": "3058492062",
"detachedFromLicenseIdShort": 3058492062,
"licenseId": "13176143868035619256",
"licenseIdShort": 2880723384
}
]
}
Repeated download of the cancellation file
POST /v1.0/lm/cancelled/download
Allows you to download the cancellation file for a detached license once again.
RAW JSON input parameters:
{
"licenseId" : "13176143868035619256"
}
Returns cancellation files in the license field:
{
"license": "av5NMggAAAAIBwAAS *** AAAAPAAAAAAA"
}
Delete a record for a cancelled license
DELETE /v1.0/lm/cancelled/licenses
Allows you to delete the cancellation file entry for a detached license.
RAW JSON input parameters:
{
"licenseId" : "13176143868035619256"
}
Get hardware fingerprints of all known computers
GET/v1.0/lm/fingerprints?search=b2291-pc
Returns an array of hardware fingerprints of all known computers. Detach can be performed on any of them.
"My Computer" can be determined by the remote flag. Also, to get the hardware fingerprint of a local PC, use the GET /v1.0/lm/environment request
The auto field - the fingerprint was determined automatically or added via the settings (only fingerprints added via the settings can be edited)
The fingerprint field is the computer's hardware fingerprint in Base64
The hostName field is the computer name on the local network
The lmsId field is the identifier of the license manager to which the license should be transferred (needed for passing to the Detach command). It is also the identifier of the computer's hardware fingerprint.
The issueTime field is the time the hardware fingerprint was obtained
The remote field - is true for all remote license managers, false for the local computer
A search by computer name is available.
RAW JSON input parameters:
{
"fingerprints": [
{
"auto" : true,
"fingerprint": "w9l/ZEgKAAAA ***** AAAAAAAAAAAAAAAAAAAAAAAA==",
"hostName": "B2291-PC",
"issueTime": 1650641434,
"lmsId": "102826192",
"remote": false
},
{
"auto" : false,
"fingerprint": "rPIVmRwKAAAAAAAAAAAAAA *** AAAAAAAAAA=",
"hostName": "GRDBENCH-01",
"issueTime": 1650641433,
"lmsId": "2957062961",
"remote": true
}
]
}
Add a new hardware fingerprint for the computer
POST /v1.0/lm/fingerpints
The entire object or just the required fields.
RAW JSON input parameters:
{
"fingerprint": "w9l/ZEgKAAAA ***** AAAAAAAAAAAAAAAAAAAAAAAA==",
"hostName": "B2291-PC",
"issueTime": 1650641433,
"lmsId": "2957062961"
}
Returns the updated fingerprints array:
{
"fingerprints": [
{
"auto" : true,
"fingerprint": "w9l/ZEgKAAAA ***** AAAAAAAAAAAAAAAAAAAAAAAA==",
"hostName": "B2291-PC",
"issueTime": 1650641434,
"lmsId": "102826192",
"remote": false
},
{
"auto" : false,
"fingerprint": "rPIVmRwKAAAAAAAAAAAAAA *** AAAAAAAAAA=",
"hostName": "GRDBENCH-01",
"issueTime": 1650641433,
"lmsId": "2957062961",
"remote": true
}
]
}
Edit a previously added hardware fingerprint
PUT /v1.0/lm/fingerpints
The entire object or just the required fields.
RAW JSON input parameters:
{
"hostName": "B2291-PC",
"lmsId": "2957062961"
}
Returns the updated fingerprints array:
{
"fingerprints": [
{
"auto" : true,
"fingerprint": "w9l/ZEgKAAAA ***** AAAAAAAAAAAAAAAAAAAAAAAA==",
"hostName": "B2291-PC",
"issueTime": 1650641434,
"lmsId": "102826192",
"remote": false
},
{
"auto" : false,
"fingerprint": "rPIVmRwKAAAAAAAAAAAAAA *** AAAAAAAAAA=",
"hostName": "GRDBENCH-01",
"issueTime": 1650641433,
"lmsId": "2957062961",
"remote": true
}
]
Remove previously added hardware fingerprint
DELETE /v1.0/lm/fingerprints
The entire object or just the required fields.
RAW JSON input parameters:
{
"lmsId": "2957062961"
}
Returns the updated licenses array:
{
"fingerprints": [
{
"auto" : true,
"fingerprint": "w9l/ZEgKAAAA ***** AAAAAAAAAAAAAAAAAAAAAAAA==",
"hostName": "B2291-PC",
"issueTime": 1650641434,
"lmsId": "102826192",
"remote": false
},
{
"auto" : false,
"fingerprint": "rPIVmRwKAAAAAAAAAAAAAA *** AAAAAAAAAA=",
"hostName": "GRDBENCH-01",
"issueTime": 1650641433,
"lmsId": "2957062961",
"remote": true
}
]
}
