Incident Management
ESET PROTECT Platform provides the Incidents v3 API that will replace the Incidents v2 API over time. Incidents v3 API uses a new incident-centric data model in which incidents are the primary objects for detection, investigation and response workflows. Incidents v3 API also provides access to indicators associated with incidents and to indicators that are not associated with incidents. Indicators v3 API calls will replace most features provided by the existing Detections v2 API calls.
Incidents v3 and Indicators v3 APIs provide data in the format based on the Elastic Common Schema (ECS).
Currently, Incident Management v1 and v2 APIs remain available alongside v3:
•v1 API calls are intended for use with ESET PROTECT and retrieve detection data.
•v2 API calls are intended for use with ESET Inspect, except for the GET /v2/detections API call, which ESET Cloud Office Security uses specifically. The v2 API calls retrieve detection data, manage detection groups, create and manage EDR rules and exclusions, and retrieve and manage incident data.
•v3 API calls are intended for use with ESET PROTECT with EDR/XDR capabilities, and work with incidents created from indicators rather than legacy detections.
Main changes
•The Indicators v3 API replaces detection retrieval and provides complete indicator data in the ECS-based format.
•Detection Groups do not have direct equivalents. Incidents and the associated indicators represent the correlated security information.
•The Indicators v3 API does not support operations to resolve individual detections or detection groups.
•The Incidents v3 API replaces the Incidents v2 API and uses an incident-centric data model to retrieve and manage incidents.
•Existing comment management remains available through the Incidents Comments v3 API.
•The Incidents v3 API provides operations to list and retrieve indicators associated with a specific incident. These operations do not have direct equivalent in the Incidents v2 API.
Mapping between v1, v2 and v3 endpoints
The table maps the existing v1 and v2 endpoints to the corresponding v3 endpoints. It does not represent a strict one-to-one mapping because the new API model introduces changes to resources, operations, and data structures. Some v2 endpoints do not have direct equivalents, and some v3 endpoints provide additional capabilities.
Existing Incident Management v1 or v2 endpoint |
Replacement Incident Management v3 endpoint |
|---|---|
List detections GET /v1/detections |
List indicators GET /v3/indicators |
Get detection GET /v1/detections/{detectionUuid} |
Get indicator GET /v3/indicators/{indicatorUuid} |
List detections GET /v2/detections |
List indicators GET /v3/indicators |
Get detection GET /v2/detections/{detectionUuid} |
Get indicator GET /v3/indicators/{indicatorUuid} |
Batch get detections POST /v2/detections:batchGet |
List indicators GET /v3/indicators |
Resolve detection POST /v2/detections/{detectionUuid}:resolve |
No replacement |
List detection groups GET /v2/detection-groups |
No replacement |
Get detection group GET /v2/detection-groups/{detectionGroupUuid} |
No replacement |
Search detection groups POST /v2/detection-groups:search |
No replacement |
Resolve detection group POST /v2/detection-groups/{detectionGroupUuid}:resolve |
No replacement |
List incidents GET /v2/incidents |
List incidents GET /v3/incidents |
Get incident GET /v2/incidents/{incidentUuid} |
Get incident GET /v3/incidents/{incidentUuid} |
Update incident basic attributes POST /v2/incidents/{incidentUuid}/basic-attributes:update |
Update incident PATCH /v3/incidents/{incident.uuid} |
Close incident POST /v2/incidents/{incidentUuid}:close |
Close incident POST /v3/incidents/{incidentUuid}:close |
Reopen incident POST /v2/incidents/{incidentUuid}:reopen |
Reopen incident POST /v3/incidents/{incidentUuid}:reopen |
List incident comments GET /v2/incidents/{incidentUuid}/comments |
List incident comments GET /v3/incidents/{incidentUuid}/comments |
Create incident comment POST /v2/incidents/{incidentUuid}/comments |
Create incident comment POST /v3/incidents/{incidentUuid}/comments |
Get incident comment GET /v2/incidents/{incidentUuid}/comments/{commentUuid} |
Get incident comment GET /v3/incidents/{incidentUuid}/comments/{commentUuid} |
Delete incident comment DELETE /v2/incidents/{incidentUuid}/comments/{commentUuid} |
Delete incident comment DELETE /v3/incidents/{incidentUuid}/comments/{commentUuid} |
Update incident comment text POST /v2/incidents/{incidentUuid}/comments/{commentUuid}/text:update |
Update incident comment text POST /v3/incidents/{incidentUuid}/comments/{commentUuid}/text:update |
No existing equivalent |
List incident indicators GET /v3/incidents/{incidentUuid}/indicators |
No existing equivalent |
Get incident indicator GET /v3/incidents/{incidentUuid}/indicators/{indicatorUuid} |
We encourage customers who use Incidents v2 API calls to plan a migration of their integrations to Incidents v3 API calls. Customers who export detection data using the Detections v2 API calls and need access to individual security findings outside of the incident workflows can use the Indicators v3 API calls. However, we recommend using incidents as the primary integration object.
ESET Inspect is scheduled for consolidation into ESET PROTECT (Open XDR). Not all Incident Management v2 API calls used with ESET Inspect have a fully equivalent replacement. Customers whose integrations depend on the affected API calls retain access to ESET Inspect until suitable replacement capabilities become available in ESET PROTECT. The Incident Management v1 and v2 APIs will be discontinued over time. |
ESET Cloud Office Security
ESET Cloud Office Security detections are currently available through the Incident Management v2 API calls:
•GET /v2/detections retrieves a list ESET Cloud Office Security detection.
•POST /v2/detections:batchGet retrieves ESET Cloud Office Security detections in batches.
•GET /v2/detections/{detectionUuid} retrieves details about a specific ESET Cloud Office Security detection.
Over time, the Indicators v3 and Incidents v3 API will also provide access to ESET Cloud Office Security detections. You can then access ESET Cloud Office Security security data through the same API model as other security data in ESET PROTECT Open XDR.
Browse the methods below or in the Table of Contents.
Detections
v1
Method |
Path |
Summary |
|---|---|---|
List detections |
||
Get detection |
v2
Method |
Path |
Summary |
|---|---|---|
List detections |
||
Get detection |
||
Resolve detection |
||
Batch get detections |
DetectionGroups
v2
Method |
Path |
Summary |
|---|---|---|
List detection groups |
||
Get detection group |
||
Resolve detection group |
||
Search detection groups |
EdrRuleExclusions
v2
Method |
Path |
Summary |
|---|---|---|
List EDR rule exclusions |
||
Create EDR rule exclusion |
||
Get EDR rule exclusion |
||
Delete EDR rule exclusion |
||
Update EDR rule exclusion definition |
EdrRules
v2
Method |
Path |
Summary |
|---|---|---|
List EDR rules |
||
Create EDR rule |
||
Get EDR rule |
||
Delete EDR rule |
||
Disable EDR rule |
||
Enable EDR rule |
||
Update EDR rule definition |
Incidents
v2
Method |
Path |
Summary |
|---|---|---|
List incidents |
||
Get incident |
||
Update incident basic attributes |
||
Close incident |
||
Reopen incident |
v3
Method |
Path |
Summary |
|---|---|---|
List incidents |
||
Update incident |
||
Get incident |
||
List incident indicators |
||
Get incident indicator |
||
Close incident |
||
Reopen incident |
||
Start progress |
IncidentComments
v2
Method |
Path |
Summary |
|---|---|---|
List incident comments |
||
Create incident comment |
||
Get incident comment |
||
Delete incident comment |
||
/v2/incidents/{incidentUuid}/comments/{commentUuid}/text:update |
Update incident comment text |
v3
Method |
Path |
Summary |
|---|---|---|
List incident comments |
||
Create incident comment |
||
Get incident comment |
||
Delete incident comment |
||
/v3/incidents/{incidentUuid}/comments/{commentUuid}:updateText |
Update incident comment text |
Indicators
v3
Method |
Path |
Summary |
|---|---|---|
List indicators |
||
Get indicator |