GET suppliers

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

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

Путь

/api/%API_VERSION%/suppliers

Метод

GET

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

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

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

Имя

Значение

Описание

Authorization

string (base 64)

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

Accept

application/json

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

Тело запроса

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

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

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

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

 

Accept: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

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

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

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

Имя

Значение

Описание

Content-Type

application/json

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

Content-Length

integer

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

Тело ответа

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

[

{

"name":"%SUPPLIER_NAME_1%",

"status": "%SUPPLIER_STATUS%"

},

...

{

"name":"%SUPPLIER_NAME_N%",

"status": "%SUPPLIER_STATUS%"

}

]

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

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

Свойство

Значение

Описание

name

string

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

status

string

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

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

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

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

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

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 99

[

{"name":"ExampleSupplier", "status":"enabled"}, {"name":"AnotherExampleSupplier", "status":"disabled"}

]

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

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

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

[

{

"status": "An error occurred while getting a list of suppliers",

}

]

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

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

Свойство

Значение

Описание

status

string

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

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

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

НТТР/1.1 500 Internal Server Error

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

Content-Type: application/json

Content-Length: 63

[{"status": "An error occurred while getting a list of suppliers"}]

В начало