Select the tab
ESET Connect – Table of Contents

How the API works

API request structure

The following HTTP methods are available in ESET Connect: GET, POST, PUT, DELETE.

Each API call consists of:

HTTP method

Request URL

Request headers (one of them contains the authentication token)

Request body (for POST and PUT calls)

Server response structure

Each API call receives a response from the server. The server response consists of:

HTTP status code

Response body formatted as data in JSON or XML

Response headers

Pending response behavior

When you send the API query, the time to retrieve the response may vary—see the table below:

Response time

Response behavior and recommended user action

The response is ready within 30 seconds.

You will receive the response.

The response is not ready within 30 seconds.

You will receive the 202 Accepted response. The response will contain the response-id header, and the query will be cached.

You can retrieve the query results later by resending an identical query (only the Token can differ) with the response-id header received in the previous step. You can send the query repeatedly.

If the query is still not ready, you will receive the 202 Accepted response again.

If the query is ready, you will receive the requested data.

After you retrieve a valid response, the cache is cleared, and you will start receiving the 404 Not Found error.

The response is not ready within 120 seconds.

You will receive the 504 Timeout error, and you must repeat the query.

You do not retrieve the valid response within 10 minutes.

The cache will be cleared, and you will receive the 404 Not Found error.


Note

See also the ESET Connect status codes.