Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Warning |
|---|
Deprecated as of version 2.7.5. Use Edit Metadata Key - API instead. |
/rest/{version}/customize/scanmetadata/keys/{metadataKeyId}/update
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Updates existing 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 | No | The updated 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:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data "key=Oh, I gotta brand new pair of rollerskates Title&active=false" http://localhost:8080/threadfix/rest/latest/customize/scanmetadata/keys/{metadataKeyId}/update |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 1,
"active": false,
"key": "Oh, I gotta brand new pair of rollerskates"
}
} |
| Page Tree | ||
|---|---|---|
|