Просмотр списка инцидентов
GET /xdr/api/v1/incidents
Возвращает список инцидентов для указанных тенантов.
Параметры запроса
Имя | Тип данных | Обязательное ли поле | Описание | Пример значения |
page | Числовое | Нет | Номер страницы. Начинается с 1. Размер страницы – 100 записей. Если значение не указано или установлено значение меньше 1, используется значение 1. | 1 |
id | Строка | Нет | Идентификатор инцидента. Если указано несколько значений, формируется список, к которому применяется логический оператор ИЛИ. Если инцидент с указанным идентификатором не найден, это значение идентификатора игнорируется. Если значение идентификатора не указано, возвращаются все инциденты для указанных тенантов. | 00000000-0000-0000-0000-000000000000 |
tenantID | Строка | Да | Идентификатор тенанта. Если указано несколько значений, формируется список, к которому применяется логический оператор ИЛИ. Если у пользователя нет права Чтение для любого из указанных тенантов, запрос не выполняется. | 00000000-0000-0000-0000-000000000000 |
name | Строка | Нет | Имя инцидента в формате Perl Compatible Regular Expression (PCRE). Если имя не указано, возвращаются все инциденты для указанных тенантов. | incident ^My incident$ |
timestampField | Строка | Нет | Поле данных инцидента, используемое для фильтрации списка инцидентов. Используйте значения "от" и "до", чтобы указать период. | createdAt updatedAt statusChangedAt |
from | Строка | Нет | Начало периода, используемого для фильтрации списка инцидентов, в формате RFC3339. Используйте значение timestampField, чтобы указать поле данных инцидента. | 2021-09-06T00:00:00Z 2021-09-06T00:00:00.000Z 2021-09-06T00:00:00Z+00:00 |
to | Строка | Нет | Окончание периода, используемого для фильтрации списка инцидентов, в формате RFC3339. Используйте значение timestampField, чтобы указать поле данных инцидента. | 2021-09-06T00:00:00Z 2021-09-06T00:00:00.000Z 2021-09-06T00:00:00Z+00:00 |
status | Строка | Нет | Статус инцидента. Если указано несколько значений, формируется список, к которому применяется логический оператор ИЛИ. | new inProgress hold closed |
withAffected | bool | Нет | Указывает, следует ли включать подробные данные об активах и учетных записях, связанных с алертами. | /xdr/api/v1/incidents?withAffected /xdr/api/v1/incidents?withAffected=123 |
withHistory | bool | Нет | Указывает, следует ли включать данные об изменениях, внесенных в инциденты. | /xdr/api/v1/incidents?withHistory /xdr/api/v1/incidents?withHistory=123 |
Действие по реагированию
HTTP-код: 200
Формат: JSON
Пример:
|
Возможные ошибки
HTTP-код | Описание | Значение поля | Значение поля |
400 | Недопустимое значение timestampField. | Недопустимое поле отметки времени. |
|
400 | Недопустимое значение "от". | Не удалось проанализировать. | Переменная. |
400 | Недопустимое значение. | Не удалось проанализировать. | Переменная. |
400 | Значение ID не в формате UUID. |
|
|
403 | Пользователь не имеет необходимых прав в функциональной области Алерты и инциденты ни у одного из указанных тенантов. | Доступ запрещен. |
|
500 | Любые другие внутренние ошибки. | Переменная. | Переменная. |