PUT suppliers/{supplier}

Обновление указанной информации об источнике данных об угрозах.

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

Путь

/api/%API_VERSION%/suppliers/{supplier}

Метод

PUT

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

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

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

Имя

Значение

Описание

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).

Параметры запроса

Этот запрос имеет следующие параметры:

Параметры запроса

Имя

Тип параметра

Описание

supplier

Путь

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

Тело запроса

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

[

{

"name":"%SUPPLIER_NAME%",

"status":"%SUPPLIER_STATUS%,

"confidence": %SUPPLIER_CONFIDENCE%,

"retention": %SUPPLIER_RETENTION%,

"vendor": "%SUPPLIER_VENDOR%"

}

]

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

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

Свойство

Значение

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

Описание

name

string

Нет

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

status

string

Нет

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

Если источник данных об угрозах требуется включить, значение должно быть enabled.

Если источник данных об угрозах требуется отключить, значение должно быть disabled.

confidence

integer

Нет

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

retention

integer

Нет

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

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

vendor

string

Нет

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

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

Ниже приведен пример запроса PUT suppliers/{supplier}.

PUT https://192.0.2.57/api/1.1/suppliers/ExampleSupplier

Accept: application/json

Content-Type: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

Content-Length: 41

 

[

{"name":"NewName", "confidence": 90}

]

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

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

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

Имя

Значение

Описание

Content-Type

application/json

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

Content-Length

integer

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

Тело ответа

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

[

{

"status": "Supplier info successfully updated"

}

]

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

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

Свойство

Значение

Описание

status

string

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

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

Ниже приведен пример ответа на запрос PUT suppliers/{supplier}.

НТТР/1.1 201 ОК

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

Content-Type: application/json

Content-Length: 46

[{"status": "Supplier info successfully updated"}]

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

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

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

[

{

"status": "An error occurred while updating Supplier info",

"reason": "%REASON%"

}

]

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

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

Свойство

Значение

Описание

status

string

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

reason

string

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

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

Ниже приведен пример ответа с ошибкой на запрос PUT suppliers/{supplier}.

НТТР/1.1 404 Supplier doesn't exist

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

Content-Type: application/json

Content-Length: 93

 

[{"status": "An error occurred while updating supplier info", "reason": "Supplier doesn't exist"}]

В начало