Business products policy – Table of Contents

ESET cloud consoles application programming interfaces (API)

Copy current article URL Share via email

This article (PDF) Whole documentation (PDF)

To understand how changes affect your integration, it is important to distinguish between the gateway and the application programming interface (API) categories it serves.

ESET Connect (gateway)

ESET Connect is a cloud-hosted gateway managed entirely by ESET. It acts as the entry point between the client and the backend services of the following ESET cloud services:

•ESET PROTECT (Cloud)

•ESET Inspect

•ESET Cloud Office Security

ESET Connect API Categories

The Gateway provides access to specific sets of APIs, which are organized into Categories.

Versioning	Each API category has its own independent versioning lifecycle. This is the version you specify in your code link (e.g., /v1/groups).
Impact	Updates to ESET Connect API Categories can change the API calls.
End of Life policy	Support Policy Category E

Breaking change policy

ESET may make changes without prior notice if the change is considered non-breaking.

ESET will make reasonable efforts to notify you of breaking changes in advance with sufficient time to adapt to these changes.

A breaking change is a change to application programming interfaces (APIs) that may require modifications to an application to avoid disruption to your integration or necessitate changes to maintain compatibility.

The following are a few examples of changes that we consider to be breaking changes:

•changed response format,

•field renamed,

•field Removed,

•data type change,

•error code change,

•business logic change.

Breaking changes can also be caused by changes related to authentication, permission scope, rate limits, transport/URL changes, and other factors.

A non-breaking change is a change that you can adapt to at your own discretion and pace without disruption.

The following are a few examples of changes that we consider not to be breaking changes:

•new field added,

•new optional parameter added,

•new value added,

•increased rate limit,

•support of more formats, etc.

Transition period

During the transition period, as the timeframe during which a previous version of an API Category remains available after the introduction of the new API Category version or functional replacement is introduced, the previous version will continue to be available for a defined, Limited Support period. ESET will make reasonable efforts to ensure compatibility and provide customers sufficient time to adapt to these changes.

The Limited Support of the ESET Connect API Categories version starts on the announced date, usually on the public announcement date to end-customers. The ESET Connect API Categories version will move to the Limited Support and will be available throughout the period until its End of Life date. After the Limited Support has elapsed, the ESET Connect API Categories version will no longer be available.

Versioning policy

Breaking Changes	Any version containing a breaking change will be clearly marked in the documentation.
Non-Breaking Changes	If a release contains only non-breaking changes, the API Category version remains the same. Details can be found in the ESET Connect Online help documentation.

˄˅