POST suppliers

Добавление нового источника данных об угрозах.

Добавленный источник данных об угрозах является источником данных об угрозах REST API, и им можно управлять с помощью методов REST API. Новый источник данных об угрозах включен по умолчанию.

Путь

/api/%API_VERSION%/suppliers

Метод

POST

Заголовки запроса

Этот запрос имеет следующие заголовки.

Заголовки запроса

Имя

Значение

Описание

Authorization

string (base 64)

Строка аутентификации.

Accept

application/json

Тип содержимого ответа.

Content-Type

application/json

Тип содержимого запроса.

Также можно указать кодировку utf-8. Например: Content-Type: application/json; charset=utf-8

Content-Length

integer

Размер тела запроса в байтах.

Максимальный размер тела этого запроса составляет 128 МБ (134217728).

Тело запроса

Тело этого запроса содержит массив JSON с объектом источника данных об угрозах. Должен быть указан только один объект источника данных об угрозах.

[

{

"name":"%SUPPLIER_NAME%",

"confidence": %SUPPLIER_CONFIDENCE%,

"retention": %SUPPLIER_RETENTION%,

"vendor": "%SUPPLIER_VENDOR%"

}

]

Свойства объекта источника данных об угрозах описаны в следующей таблице.

Свойства объекта источника данных об угрозах

Свойство

Значение

Обязательный

Описание

name

string

Да

Имя источника данных об угрозах.

Имя источника данных об угрозах должно содержать только латинские буквы, цифры, дефисы («-») и символы подчеркивания («_»). В имени источника данных об угрозах не допускаются символы пробела (« »).

В качестве имени источника данных об угрозах не следует использовать FalsePositive или InternalTI, поскольку эти имена зарезервированы для встроенных источников данных об угрозах Kaspersky CyberTrace.

confidence

integer

Да

Уровень доверия к индикаторам из этого источника данных об угрозах.

Диапазон значений этого параметра: от 0 до 100.

retention

integer

Да

Срок хранения индикаторов в минутах.

Этот параметр определяет время, по истечении которого индикаторы этого источника данных об угрозах перестают использоваться в сопоставлении. Время отсчитывается от последнего обновления индикатора.

vendor

string

Нет

Имя поставщика источника данных об угрозах.

Пример запроса

Ниже приведен пример запроса POST suppliers.

POST https://192.0.2.57/api/1.1/suppliers

Accept: application/json

Content-Type: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

Content-Length: 91

[

{"name":"ExampleSupplier", "confidence": 90, "retention": 5000, "vendor": "ExampleVendor"}

]

Заголовки ответа

Ответ имеет следующие заголовки.

Заголовки ответа

Имя

Значение

Описание

Content-Type

application/json

Тип содержимого ответа.

Content-Length

integer

Размер тела ответа в байтах.

Тело ответа

Тело ответа содержит объект JSON со статусом операции.

[

{

"status": "Supplier successfully created"

}

]

Свойства объекта статуса описаны в следующей таблице.

Свойства объекта статуса

Свойство

Значение

Описание

status

string

Статус операции.

Пример ответа

Ниже приведен пример ответа на запрос POST suppliers.

НТТР/1.1 201 ОК

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 41

[{"status": "Supplier successfully created"}]

Ответы с ошибкой

Ответы с ошибкой содержат информацию о статусе ответа.

Ответ с ошибкой содержит объект JSON с описанием ошибки.

[

{

"status": "An error occurred while creating some suppliers",

"reason": "%REASON%"

}

]

Описание свойств объекта ошибки приведено в следующей таблице.

Свойства объекта ошибки

Свойство

Значение

Описание

status

string

Описание ошибки.

reason

string

Причина ошибки.

Пример ошибочного ответа

Ниже приведен пример ответа с ошибкой на запрос POST suppliers.

HTTP/1.1 400 Bad Request

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 92

 

[{"status": "An error occurred while creating some suppliers", "reason": "Incorrect supplier name"}]

В начало