Поиск алертов
GET /api/v1/alerts
Доступ: администратор, аналитик, оператор.
Параметры запроса
Имя | Тип данных | Обязательный | Описание | Пример значения |
page | number | Нет | Номер страницы. Начинается с 1. Размер страницы – 250 записей. Если параметр не указан, то используется значение по умолчанию – 1. | 1 |
id | string | Нет | Идентификатор алерта. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ. | 00000000-0000-0000-0000-000000000000 |
tenantID | string | Нет | Идентификатор тенанта алерта. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ. Если пользователь не имеет необходимой роли в указанном тенанте, то данный тенант игнорируется. | 00000000-0000-0000-0000-000000000000 |
name | string | Нет | Имя алерта. Регистронезависимое регулярное выражение (PCRE). | alert |
timestampField | string | Нет | Имя поля алерта, по которому выполняется сортировка (DESC) и поиск по периоду (from – to). По умолчанию lastSeen. | lastSeen, firstSeen |
from | string | Нет | Нижняя границы периода в формате RFC3339. <timestampField> >= <from> | 2021-09-06T00:00:00Z (UTC) 2021-09-06T00:00:00.000Z (UTC, с указанием миллисекунд) 2021-09-06T00:00:00Z+00:00 (MSK) |
to | string | Нет | Верхняя периода в формате RFC3339. <timestampField> <= <to> | 2021-09-06T00:00:00Z (UTC) 2021-09-06T00:00:00.000Z (UTC, с указанием миллисекунд) 2021-09-06T00:00:00Z+00:00 (MSK) |
status | string | Нет | Статус алерта. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ. | new, assigned, escalated, closed |
withEvents | bool | Нет | Включить в ответ нормализованные события KUMA, связанные с найденными алертами. Если параметр присутствует в URL query, его значение принимается за true. Указанные пользователем значения игнорируются. Пример: /api/v1/alerts?withEvents |
|
withAffected | bool | Нет | Включить в ответ информацию об активах и аккаунтах, связанных с найденными алертами. Если параметр присутствует в URL query, его значение принимается за true. Указанные пользователем значения игнорируются. Пример: /api/v1/alerts?withAffected |
|
Ответ
HTTP-код: 200
Формат: JSON
|
Возможные ошибки
HTTP-код | Описание | Значение поля message | Значение поля details |
400 | Неверное значение параметра page | invalid query parameter value | page |
400 | Неверное значение параметра status | invalid status | <status> |
400 | Неверное значение параметра timestampField | invalid timestamp field |
|
400 | Неверное значение параметра from | cannot parse from | вариативное |
400 | Неверное значение параметра to | cannot parse to | вариативное |
400 | Значение параметра from больше значения параметра to | from cannot be greater than to |
|
500 | Любые другие внутренние ошибки | вариативное | вариативное |