Search

ESET Inspect On-Prem

ESET Inspect On-Prem – Table of Contents

REST API

Copy current article URL Share via email

This article (PDF) Whole documentation (PDF)

REST API documentation is available only in English.

Authentication

Method	Path	Summary
	/api/v1/authenticate	Authentication
	/api/v1/authenticate	Authentication

Detections

Method	Path	Summary
	/api/v1/detections	Get a list of detections
	/api/v1/detections/{alarm}	Get the detection details
	/api/v1/detections/{alarm}	Get the detection details

Remediation

Method	Path	Summary
	/api/v2/executables/{module}/block	Block an executable
	/api/v2/executables/{module}/unblock	Unblock an executable
	/api/v1/machines/{process}/kill	Kill a process on EI Connector side
	/api/v1/epxprocess/kill	Kill a process on EI Connector side

Rules

Method	Path	Summary
	/api/v1/rules	Get a list of rules
	/api/v2/rules	Create a new rule
	/api/v1/rules/{rule}	Get a single rule
	/api/v1/rules/{rule}	Delete a rule
	/api/v1/rules/{rule}	Delete a rule
	/api/v2/rules/{rule}	Edit the rule body

Exclusions

Method	Path	Summary
	/api/v1/exclusions	Get a list of exclusions
	/api/v2/exclusions	Create a new exclusion
	/api/v1/exclusions/{exclusion}	Get a single exclusion
	/api/v1/exclusions/{exclusion}	Delete an exclusion
	/api/v3/exclusions/rule/{rule}	Get a single exclusion
	/api/v2/exclusions/{exclusion}	Edit the exclusion body
	/api/v1/exclusions/rule/{rule}	Get the exclusions associated with a rule

Computers

Method	Path	Summary
	/api/v1/machines/{machine}/isolate	Isolate the computer from the network
	/api/v1/machines/{machine}/integrate	Integrate the computer back into the network
	/api/v1/computers/{machine}	Get a computer object with ID, UUID and name
	/api/v1/computers	Get a list of computers with ID, UUID and name
	/api/v1/computers/{machine}/integrate	Integrate a computer back into the network
	/api/v1/computers/{machine}/isolate	Isolate a computer from the network

Processes

Method	Path	Summary
	/api/v2/processes/{process}	Get basic process information
	/api/v1/epxprocesses	Get basic process information
	/api/v2/processtree/{process}	Get process hierarchy information

Modules

Method	Path	Summary
	/api/v1/modules/{modules}	Get module details
	/api/v1/modules	Get a list of modules

˄˅