GET tags

11 апреля 2024

ID 222773

Получение списка тегов.

Путь

/api/%API_VERSION%/tags

Метод

GET

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

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

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

Имя

Значение

Описание

Authorization

string (base 64)

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

Accept

application/json

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

Тело запроса

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

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

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

GET https://192.0.2.57/api/1.1/tags

Accept: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

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

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

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

Имя

Значение

Описание

Content-Type

application/json

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

Content-Length

integer

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

Тело ответа

Тело ответа содержит массив JSON, содержащий объекты тегов.

[

{

"name": "%TAG_NAME_1%",

"weight": %TAG_WEIGHT_1%

},

...

{

"name": "%TAG_NAME_N%",

"weight": %TAG_WEIGHT_N%

}

]

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

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

Свойство

Значение

Описание

name

string

Имя тега.

weight

integer

Значимость тега от 0 (наименьшая значимость) до 5 (наибольшая значимость).

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

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

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"name": "WIN-TROJAN",

"weight": 5

},

{

"name": "KASPERSKY",

"weight": 5

},

{

"name": "OSINT",

"weight": 2

}

]

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

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

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

[

{

"status": "An error occurred while getting tags list";

"reason": "%REASON%"

}

]

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

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

Свойство

Значение

Описание

status

string

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

reason

string

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

Это свойство может отсутствовать.

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!