Create Scan Metadata Key - API

/rest/customize/scanmetadata/keys/new

Descriptor	Value
HTTP Method	POST
Description	Creates a new scan metadata key
Required Permission	Manage Scan Metadata Keys
Version Introduced	2.7.1

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
key	String	Yes	The name to assign the new metadata key.	N/A
active	String	No	Sets the meta data key to active or inactive.	“TRUE”, “FALSE”

Sample Call:

curl --insecure -H 'Accept: application/json' -X POST --data "key=Port Key Title&active=true" http://localhost:8080/threadfix/rest/customize/scanmetadata/keys/new?apiKey={apiKey}

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 2,
        "active": true,
        "key": "Port Key"
    }
}