POST /api/v2/activeLists/import
Целевой коррелятор должен быть запущен.
Доступ: Главный администратор, Администратор тенанта, Аналитик второго уровня, Аналитик первого уровня (может импортировать данные в любой лист коррелятора доступного тенанта, даже если активный лист создан в Общем тенанте).
Параметры запроса (URL Query)
Имя |
Тип данных |
Обязательный |
Описание |
Пример значения |
correlatorID |
string |
Да |
Идентификатор сервиса коррелятора |
00000000-0000-0000-0000-000000000000 |
activeListID |
string |
Если не указан activeListName |
Идентификатор активного листа |
00000000-0000-0000-0000-000000000000 |
activeListName |
string |
Если не указан activeListID |
Имя активного листа |
Attackers |
format |
string |
Да |
Формат импортируемых записей |
CSV, TSV, internal |
keyField |
string |
Только для форматов csv и tsv |
Имя поля в заголовке csv или tsv файла, которое будет использовано в качестве ключевого поля записи активного листа. Значения этого поля должны быть уникальными |
ip |
clear |
bool |
Нет |
Очистить активный лист перед выполнением импорта. Если параметр присутствует в URL query, его значение принимается за true. Указанные пользователем значения игнорируются. |
/api/v2/activeLists/import?clear |
Тело запроса
Формат |
Содержимое |
CSV |
Первая строка – заголовок, где перечислены поля, разделенные запятой. Остальные строки – значения, соответствующие полям в заголовке, разделенные запятой. Количество полей на каждой строке должно быть одинаковым. |
TSV |
Первая строка – заголовок, где перечислены поля, разделенные TAB. Остальные строки – значения, соответствующие полям в заголовке, разделенные TAB. Количество полей на каждой строке должно быть одинаковым. |
internal |
Каждая строка содержит один индивидуальный объект JSON. Данные в internal формате можно получить путем экспорта содержимого активного листа из коррелятора в WEB-консоли KUMA. |
Ответ
HTTP-код: 204
Возможные ошибки
HTTP-код |
Описание |
Значение поля message |
Значение поля details |
400 |
Не указан идентификатор сервиса коррелятора |
query parameter required |
correlatorID |
400 |
Не указан ни параметр activeListID, ни параметр activeListName |
one of query parameters required |
activeListID, activeListName |
400 |
Не указан параметр format |
query parameter required |
format |
400 |
Параметр format имеет неверное значение |
invalid query parameter value |
format |
400 |
Параметр keyField не задан |
query parameter required |
keyField |
400 |
Тело запроса имеет нулевую длину |
request body required |
- |
400 |
CSV или TSV файл не содержит поле, указанное в параметре keyField |
correlator API request failed |
вариативное |
400 |
Ошибка парсинга тела запроса |
correlator API request failed |
вариативное |
403 |
Пользователь не имеет необходимой роли в тенанте коррелятора |
access denied |
- |
404 |
Сервис с указанным идентификатором (correlatorID) не найден |
service not found |
- |
404 |
Активный лист не найден |
active list not found |
- |
406 |
Сервис с указанным идентификатором correlatorID не является коррелятором |
service is not correlator |
- |
406 |
Коррелятор не выполнил первый старт |
service not paired |
- |
406 |
Тенант коррелятора отключен |
tenant disabled |
- |
406 |
Поиск активного листа выполнялся по имени activeListName и было найдено более одного активного листа |
more than one matching active lists found |
- |
50x |
Не удалось обратиться к API коррелятора |
correlator API request failed |
вариативное |
500 |
Не удалось декодировать тело ответа, полученное от коррелятора |
correlator response decode failed |
вариативное |
500 |
Любые другие внутренние ошибки |
вариативное |
вариативное |