Виберіть вкладку
ESET Inspect On-Prem – Зміст

Виключення REST API

POST — створює нове виключення

HTTP-запит:

Тіло запиту JSON:

body

(string) — XML нового виключення

autoResolve

(bool) — обробляти виявлений об’єкт автоматично чи ні

name

(string) — ім’я виключення

ruleIds

(array) — масив ідентифікаторів правил (uuid у вигляді рядків, string); можна використовувати одночасно з ruleIds

ruleUuids

(array) — масив ідентифікаторів правил (цілі числа, integer); можна використовувати одночасно з ruleUuids

note

(optional, string) — зберігає до 2048 символів

Тіло відповіді JSON:

success

HTTP-код 201 і HTTP Location. Заголовок містить URL-адресу запиту GET з ідентифікатором для новоствореного виключення. Тіло відповіді повертає JSON з об’єктом новоствореного виключення

failure

HTTP-код 404 з поясненням тіла

Недійсні виключення не збережено в ESET Inspect Database.

GET — вивести виключення

HTTP-запит:

URL-запит:

Подібно до API для отримання виявлених об’єктів, підтримує: $top, $skip, $count, $orderBy

Тіло запиту: Немає

Тіло відповіді JSON: Значення й кількість (якщо URL-запит має $count). Поле value містить масив об’єктів, що включає:

GET — отримує окреме виключення

HTTP-запит:

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила

Тіло запиту: Немає

Тіло відповіді JSON: Крім полів, що повертає список виключень, відповідь міститиме поле exclusion з XML:

PUT — змінює тіло виключення

HTTP-запит:

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила

Тіло запиту JSON: те саме, що й для нового виключення POST.

Тіло відповіді JSON: Повертає оновлений об’єкт із запитів. Подібно до POST, повертає відповідь GET.

DELETE — видаляє виключення

HTTP-запит:

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила.

Тіло запиту: немає

Тіло відповіді: немає

GET — отримання виключень, пов’язаних із правилом

HTTP-запит:

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила

Тіло запиту: Немає

Тіло відповіді JSON: Те саме, що й для GET — виведення списку виключень. Повертає масив виключень, пов’язаних із правилом.

Приклад:

example

https://192.168.197.200/api/v1/executables/066F8964A44161825BE6F4E10B05CD66F3C115FC/block?$idType=sha1, що дорівнює https://192.168.197.200/api/v1/executables/1605/block (тобто id = sha1 або ідентифікатор модуля в базі даних)