GET tags/{tag}

Получение информации об указанном теге.

Путь

/api/%API_VERSION%/tags/{tag}

Метод

GET

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

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

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

Имя

Значение

Описание

Authorization

string (base 64)

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

Accept

application/json

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

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

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

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

Имя

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

Описание

tag

Путь

Имя тега.

Тело запроса

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

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

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

GET https://192.0.2.57/api/1.1/tags/WIN-TROJAN

Accept: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

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

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

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

Имя

Значение

Описание

Content-Type

application/json

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

Content-Length

integer

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

Тело ответа

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

[

{

"name": "%TAG_NAME%",

"weight": %TAG_WEIGHT%

}

]

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

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

Свойство

Значение

Описание

name

string

Имя тега.

weight

integer

Важность тега от 0 (наименьшая важность) до 5 (наибольшая важность).

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

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

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"name": "WIN-TROJAN",

"weight": 5

}

]

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

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

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

[

{

"status": "An error occurred while getting tag info",

"reason": "Tag doesn't exist"

}

]

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

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

Свойство

Значение

Описание

status

string

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

reason

string

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

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

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

Ниже приведен пример ответа с ошибкой на запрос GET tags/{tag}.

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

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

Content-Type: application/json

Content-Length: 150

[

{

"status": "An error occurred while getting tag info",

"reason": "Tag doesn't exist"

}

]

В начало