GET tags

February 27, 2024

ID 222773

Gets a list of tags.

Path

/api/%API_VERSION%/tags

Method

GET

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.

Request body

This request has an empty body.

Request example

The following is an example of a GET tags request.

GET https://192.0.2.57/api/1.1/tags

Accept: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

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 array containing tag objects.

[

{

"name": "%TAG_NAME_1%",

"weight": %TAG_WEIGHT_1%

},

...

{

"name": "%TAG_NAME_N%",

"weight": %TAG_WEIGHT_N%

}

]

Tag object properties are described in the following table.

Tag object properties

Property

Value

Description

name

string

Name of the tag.

weight

integer

Significance of the tag, from 0 (lowest significance) to 5 (highest significance).

Response example

The following is an example of a GET tags request response.

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"name": "WIN-TROJAN",

"weight": 5

},

{

"name": "KASPERSKY",

"weight": 5

},

{

"name": "OSINT",

"weight": 2

}

]

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 getting tags list";

"reason": "%REASON%"

}

]

Error object properties are described in the following table.

Error object properties

Property

Value

Description

status

string

Error description.

reason

string

The reason of the error.

This property may be missing.

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.