Select the tab
ESET PROTECT On-Prem – Table of Contents

Set up the ESET PROTECT On-Prem REST API

Follow the steps below to set up the ESET PROTECT On-Prem REST API:

1.Enable the REST API in More > Settings.


Important

Ensure to open the API ports in your local firewall.

2.Assign the API users the API permission set.


Important

The Administrator account cannot use the API.

3.To automate interactions with the ESET PROTECT On-Prem API, implement API calls to your REST client application (for example, Postman) or you can use the command line (curl).


Note

The REST server runs locally on the ESET PROTECT Server. You cannot use ESET Connect with ESET PROTECT On-Prem REST API.

4.Execute the GetTokens request to log in to the REST server:

Method

POST

Function

getTokens

URL

https://protect_server:9443/GetTokens

Body

{

"username" : "api",

"password" : "Admin.12345678",

"grant_type" : 0

}

5.The accessToken is returned in the response. You can subsequently use the accessToken in other API requests as a bearer token (Authorization: Bearer).


Note

See also the examples of API calls and the list of all API calls available in ESET PROTECT On-Prem.