How API works

API call types

The GET, POST and DELETE API call types are available in the ESET PROTECT On-Prem API.

•The GET calls do contain any input parameters (they do not have a body) and send data directly in the URL. The request call cannot be modified; only executed.

•The POST calls require a request body—the parameters are documented for each POST call.

•In API requests that include the pagination (page_size), the dafault page size is 100 and the max. size is 10000.

Each call consists of:

•Call type

•Request URL

•Request header (can consist of the authentication token)

•Request body (contains data, especially with POST calls)

Server response structure

Each API call receives a response from the REST server. The response consists of the server response code and the response formatted as data in JSON.

The response consists of:

•Server code

•Response body

•Response headers

Examples of API calls

GET

Display a policy (The Policy_UUID is taken from the Web Console.):

POST

Move the device to a specific static group (The computer ID is included in the URL.):