Updates a specified tag.
Path
api/1.1/tags/{tag}
Method
PUT
Request headers
This request has the following headers.
Request headers
Name |
Value |
Description |
|---|---|---|
|
string (base 64) |
|
|
|
Response content type. |
|
|
Request content type. You can also specify the |
|
integer |
Request body size, in bytes. The maximum body size for this request is 128 MB ( |
Request parameters
This request has the following parameters:
Request parameters
Name |
Parameter type |
Description |
|---|---|---|
|
Path |
Name of the tag. |
Request body
This request body contains a JSON array with a tag object. Only one tag object must be specified.
[
{
"name":"%TAG_NAME%",
"weight": TAG_WEIGHT
}
]
Tag object properties are described in the following table.
Supplier object properties
Property |
Value |
Mandatory |
Description |
|---|---|---|---|
|
string |
No |
Name of the tag. The tag name must be 1 to 128 characters long. It can contain Latin letters, digits, hyphens (-), and underscores (_). You cannot use the name of an existing tag for the new tag. When changing tag names, Kaspersky CyberTrace converts letters to uppercase. |
|
integer |
No |
Significance of the tag, from |
Request example
The following is an example of a PUT tags/{tag} request.
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 } ] |
Response headers
The response has the following headers.
Response headers
Name |
Value |
Description |
|---|---|---|
Content-Type |
|
Response content type. |
Content-Length |
integer |
Response body size, in bytes. |
Response body
The response body contains a JSON object with a status of the operation.
[
{
"status": "Tag successfully updated"
}
]
Status object properties are described in the following table.
Status object properties
Property |
Value |
Description |
|---|---|---|
|
string |
Status of the operation. |
Response example
The following is an example of a response to the PUT tags/{tag} request.
НТТР/1.1 200 ОК Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 150
[ { "status": "Tag successfully updated" } ] |
Error responses
For more information about possible response statuses, see section "Response statuses".
An error response contains a JSON array with the error description.
[
{
"status": "An error occurred while updating tag",
"reason": "%REASON%"
}
]
Error object properties are described in the following table.
Error object properties
Property |
Value |
Description |
|---|---|---|
|
string |
Error description. |
|
string |
The reason of the error. This property may be missing. |
Error response example
The following is an example of a PUT tags/{tag} error response.
НТТР/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" } ] |