Licenses

Call description

This request returns a list of licenses that meet specified search parameters. The Keyword in the search parameter searches in the product code, product name, and the License ID. Customer ID is optional, if it contains a valid GUID value then only licenses of the selected customer are searched.

ESET MSP Administrator 2 API returns licenses for the logged in user

oAll licenses will be returned if you leave both parameters empty.

oOnly licenses matching the keyword will be returned if the keyword is entered.

ESET MSP Administrator 2 API returns licenses for the user defined by customerId if you have permissions for that user

oAll licenses will be returned.

oOnly licenses matching the keyword will be returned, it the keyword is entered.

To list all of your licenses, pass an empty value in the keyword parameter.

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

•Request URL: https://mspapi.eset.com/api/Search/Licenses

•This request is a POST call type.

Call structure

{

"keyword": "string",

"customerId": "string",

"skip": 0,

"take": 0

}

Call parameters

Parameter	Description
keyword	The search parameter; you can only enter one string to search for. The call searches for the keyword in following fields: productCode, productName, publicLicenseKey. If you leave the parameter with a blank value "", you get the list of all your licenses.
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
customerId	customerId is optional. Only licenses of the selected customer are searched. If you omit this parameter, it uses current user customerId.

Parameter

Description

keyword

The search parameter; you can only enter one string to search for. The call searches for the keyword in following fields: productCode, productName, publicLicenseKey.

If you leave the parameter with a blank value "", you get the list of all your licenses.

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

customerId

customerId is optional. Only licenses of the selected customer are searched. If you omit this parameter, it uses current user customerId.

Response structure

The response contains data in the JSON format.

The response contains the number of results and list of public license IDs with product codes and product names.

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

˄˅