As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Create Tag - API

/rest/{version}/tags/new


Descriptor

Value

HTTP Method

POST

Description

Creates a new tag with the given name and type and returns its JSON.

Required Permission

Manage Tags

Version Introduced2.3.0


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.


Request POST Data Parameters

Parameter

Value

Required

Description

Available Values

name

String

Yes

The name to assign the new tag. Limited to 60 characters.

N/A

tagType

String

No

The type of tag to create.  Defaults to APPLICATION.

“APPLICATION”, “COMMENT”, “VULNERABILITY”


Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data "name=TestTag&tagType=COMMENT" http://localhost:8080/threadfix/rest/latest/tags/new


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 5,
        "name": "TestTag",
        "type": "COMMENT",
		"risk": "NONE"
    }
}




www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.