POST tags

Добавление нового тега.

Путь

/api/%API_VERSION%/tags

Метод

POST

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

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

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

Имя	Значение	Описание
`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`).

Тело запроса

Тело этого запроса содержит массив 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 (наибольшая важность).

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

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

POST https://192.0.2.57/api/1.1/tags

Accept: application/json

Content-Type: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

Content-Length: 150

[

{

"name": "WIN-TROJAN",

"weight": 5

}

]

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

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

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

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

Тело ответа

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

[

{

"status": "Tag successfully created"

}

]

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

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

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

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

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

НТТР/1.1 201 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"status": "Tag successfully created"

}

]

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

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

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

[

{

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

"reason": "%REASON%"

}

]

В начало