ESET Online Help

Search
Select the topic

GetHistory

Call description

This request returns the license history for a given license. You need to have read or write access for the customer.

This API call requires authorization; the user has to be logged in.

Request URL: https://mspapi.eset.com/api/License/GetHistory

This request is a POST call type.

Call structure

{

  "publicLicenseKey": "string",

  "skip": 0,

  "take": 0

}

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.

skip, take

If the requested data set is too large, you can split the response into smaller chunks. It works similarly to the paging function. The skip parameter indicates how many entries should be skipped and the take parameter indicates how many entries should be listed. The take value must be from 1 to 100.

For example:

to list the first 20 entries, set up: "skip": 0, "take": 20

to list the second 20 entries (from 21 to 40), set up: "skip": 20, "take": 20

Response structure

The response contains data in the JSON format.

Description of return parameters:

parameter

Description

Type

1 - Cancel existing

2 - Convert to full

3 - Extend trial

4 - Order new

5 - Update unit quantity

6 - Suspend license

7 - Unsuspend license

8 - Change license key

9 - Upgrade license

10 - Downgrade license

LicenseTypeId

1 -Full

4 -Trial

 

Important result fields according to the license type:

License type

Important result fields

1

Type, Date, User

2

Type, Date, User, RequestedUnits, TrialExtensionCount

3

Type, Date, User, TrialExtensionCount

4

Type, Date, User, RequestedUnits, licenseTypeId

5

Type, Date, User, RequestedUnits, PreviousUnits

6

Type, Date, User

7

Type, Date, User

8

Type, Date, User, PreviousLicenseKey, RequestedLicenseKey

9

Type, Date, User, RequestedUnits, PreviousUnits,PreviousProductCode, RequestedProductCode

10

Type, Date, User, RequestedUnits, PreviousUnits,PreviousProductCode, RequestedProductCode

 

hmtoggle_plus0Example response

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.

List of error codes