GET suppliers/{supplier}

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

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

Путь

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

Метод

GET

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

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

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

Имя

Значение

Описание

Authorization

string (base 64)

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

Accept

application/json

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

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

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

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

Имя

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

Описание

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

Путь

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

Тело запроса

Тело этого запроса пустое.

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

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

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

 

Accept: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

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

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

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

Имя

Значение

Описание

Content-Type

application/json

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

Content-Length

integer

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

Тело ответа

Тело ответа содержит массив 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

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

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

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

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 108

[

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

]

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

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

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

[

{

"status": "Supplier doesn't exist",

}

]

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

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

Свойство

Значение

Описание

status

string

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

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

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

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

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

Content-Type: application/json

Content-Length: 34

[{"status": "Supplier doesn't exist"}]

В начало