Edit Scan Metadata Key - API

/rest/customize/scanmetadata/keys/{metadataKeyId}/update

Descriptor	Value
HTTP Method	POST
Description	Updates a scan metadata key
Required Permission	Manage Scan Metadata Keys
Version Introduced	2.7

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

Sample Call:

curl --insecure -H 'Accept: application/json' -X POST --data "key=Random Key Title&active=false" http://localhost/threadfix/rest/customize/scanmetadata/keys/{metadataKeyId}/update?apiKey={apiKey}

Sample Output:

{PLACEHOLDER ONLY!!! TO BE REPLACED WITH CORRECT RETURN MESSAGE!!
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 1,
            "active": true,
            "key": "I Gotta Brand New Pair of Rollerskates"
        },
        {
            "id": 2,
            "active": true,
            "key": "You Gotta Brand New Key"
        }
    ]
}