POST tags

February 27, 2024

ID 222772

Adds a new tag.

Path

/api/%API_VERSION%/tags

Method

POST

Request headers

This request has the following headers.

Request headers

Name

Value

Description

Authorization

string (base 64)

Authentication string.

Accept

application/json

Response content type.

Content-Type

application/json

Request content type.

You can also specify the utf-8 charset type. For example: Content-Type: application/json; charset=utf-8

Content-Length

integer

Request body size, in bytes.

The maximum body size for this request is 128 MB (134217728).

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.

Tag object properties

Property

Value

Mandatory

Description

name

string

Yes

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 adding tag names, Kaspersky CyberTrace converts letters to uppercase.

weight

integer

Yes

Significance of the tag.

The range of values for this parameter is from 0 (lowest significance) to 5 (highest significance).

Request example

The following is an example of a POST tags request.

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

}

]

Response headers

The response has the following headers.

Response headers

Name

Value

Description

Content-Type

application/json

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 created"

}

]

Status object properties are described in the following table.

Status object properties

Property

Value

Description

status

string

Status of the operation.

Response example

The following is an example of a POST suppliers request response.

НТТР/1.1 201 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"status": "Tag successfully created"

}

]

Error responses

An error response contains information about the response status.

An error response contains a JSON object with the error description.

[

{

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

"reason": "%REASON%"

}

]

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.