PUT tags/{tag}

Обновление указанного тега.

Путь

api/%API_VERSION%/tags/{tag}

Метод

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

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

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

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

Имя	Тип параметра	Описание
`tag`	Путь	Имя тега.

Тело запроса

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

[

{

"name":"%TAG_NAME%",

"weight": TAG_WEIGHT

}

]

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

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

Свойство	Значение	Обязательный	Описание
`name`	string	Нет	Имя тега. Длина тега должна составлять от 1 до 128 символов. Тег может содержать латинские буквы, цифры, дефисы (-) и знаки подчеркивания (_). Для нового тега нельзя использовать имя уже существующего тега. При изменении имен тегов Kaspersky CyberTrace преобразует буквы в верхний регистр.
`weight`	integer	Нет	Важность тега от `0` (наименьшая важность) до `5` (наибольшая важность).

Свойство

Значение

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

Описание

name

string

Нет

Имя тега.

Длина тега должна составлять от 1 до 128 символов. Тег может содержать латинские буквы, цифры, дефисы (-) и знаки подчеркивания (_). Для нового тега нельзя использовать имя уже существующего тега.

При изменении имен тегов Kaspersky CyberTrace преобразует буквы в верхний регистр.

weight

integer

Нет

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

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

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

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

Accept: application/json

Content-Type: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

Content-Length: 150

[

{

"name": "TROJAN",

"weight": 4

}

]

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

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

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

Имя	Значение	Описание
Content-Type	`application/json`	Тип содержимого ответа.
Content-Length	integer	Размер тела ответа в байтах.

Тело ответа

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

[

{

"status": "Tag successfully updated"

}

]

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

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

Свойство	Значение	Описание
`status`	string	Статус операции.

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

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

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"status": "Tag successfully updated"

}

]

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

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

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

[

{

"status": "An error occurred while updating tag",

"reason": "%REASON%"

}

]

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

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

Свойство	Значение	Описание
`status`	string	Описание ошибки.
`reason`	string	Причина ошибки. Это свойство может отсутствовать.

Свойство

Значение

Описание

status

string

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

reason

string

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

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

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

Ниже приведен пример ответа с ошибкой на запрос PUT 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 updating tag",

"reason": "Tag doesn't exist"

}

]

В начало