Get All Tags - API

/rest/{version}/tags/index

Descriptor	Value
HTTP Method	GET
Description	Retrieves a list of all tags and returns their JSON.
Required Permission	Manage Tags
Version Introduced	2.3.0

Request Header Parameters

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.

Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/tags/index

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "Vulnerability Tag": [],
        "Application Tag": [
            {
                "id": 3,
                "active": true,
                "name": "HIPAA",
                "enterpriseTag": true,
                "defaultJsonFilter": "{\"tags\":[],\"severities\":{\"critical\":true,\"high\":true,\"medium\":true,\"low\":false,\"info\":false},\"daysOldModifier\":\"Forever\",\"filterType\":{\"isComplianceFilter\":true}}",
                "type": "APPLICATION",
                "encodedName": null,
                "deletable": false
            },
            {
                "id": 1,
                "active": true,
                "name": "PCI",
                "enterpriseTag": true,
                "defaultJsonFilter": "{\"tags\":[],\"severities\":{\"critical\":true,\"high\":true,\"medium\":true,\"low\":true,\"info\":true},\"daysOldModifier\":\"Forever\",\"filterType\":{\"isComplianceFilter\":true}}",
                "type": "APPLICATION",
                "encodedName": null,
                "deletable": false
            }
        ],
        "Vulnerability Comment Tag": [
            {
                "id": 4,
                "active": true,
                "name": "HIPAA",
                "enterpriseTag": true,
                "defaultJsonFilter": "{\"tags\":[],\"severities\":{\"critical\":true,\"high\":true,\"medium\":true,\"low\":false,\"info\":false},\"daysOldModifier\":\"Forever\",\"filterType\":{\"isComplianceFilter\":true}}",
                "type": "COMMENT",
                "encodedName": null,
                "deletable": false
            },
            {
                "id": 2,
                "active": true,
                "name": "PCI",
                "enterpriseTag": true,
                "defaultJsonFilter": "{\"tags\":[],\"severities\":{\"critical\":true,\"high\":true,\"medium\":true,\"low\":true,\"info\":true},\"daysOldModifier\":\"Forever\",\"filterType\":{\"isComplianceFilter\":true}}",
                "type": "COMMENT",
                "encodedName": null,
                "deletable": false
            },
            {
                "id": 5,
                "active": true,
                "name": "TestTag",
                "enterpriseTag": false,
                "defaultJsonFilter": null,
                "type": "COMMENT",
                "encodedName": null,
                "deletable": true
            }
        ]
    }
}