Detail
Call description
This request returns detailed information about a given license. The response contains information about the license and about licenses to which this license can be upgraded or downgraded.
•This API call requires authorization; the user has to be logged in.
•Request URL: https://mspapi.eset.com/api/License/Detail
•This request is a POST call type.
Call structure
{
"publicLicenseKey": "string"
}
Call parameters
Parameter |
Description |
|---|---|
publicLicenseKey |
Public License ID number in the following format XXX-XXX-XXX. Mandatory input parameter. A proper value must be set. |
Response structure
The response contains data in the JSON format.
Description of the return parameters:
Parameter |
Description |
|---|---|
customerId |
Public ID of the Customer who owns the license. |
lastUpdate |
When the last operation over the license was executed. |
lastUpdateBy |
Public ID of the user who made the last license update. |
publicLicenseKey |
Public license key (same as the input parameter) |
productCode |
Code of the product for the license order. |
productName |
Name of the product for the license order. |
quantity |
The seat count for the license. |
usage |
The number of activated units. |
state |
The license status. See the list of license states. |
trial |
States if the license is a Trial (true/false). |
trialExpiration |
Expiration date of license if it’s a trial (if not trial license, null is returned). |
trialExtensions |
Number of times the trial license was extended (if not trial license, null is returned). |
bundleProducts |
If the request called a license bundle, the response contains also the bundleProducts field. It lists all products in the bundle, their quantity and usage. |
upgradeableTo |
Product codes of licenses to which current license can be upgraded to. This parameter is in the response only if the license can be upgraded. |
downgradeableTo |
Product codes of licenses to which current license can be downgraded to. This parameter is in the response only if the license can be downgraded. |
Troubleshooting
ESET MSP Administrator 2 API uses standardized error codes. If you are getting errors or unexpected responses, see the Troubleshooting API for common problems and the list of error codes.