Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/customize/scanmetadata/keys/{metadataKeyId}/update
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Updates scan metadata |
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 | Integer | No | The scan metadata key for the metadata which will be edited. | N/A |
description | String | No | Text for description field. | N/A |
| title | String | No | Scan Metadata key title. Used if key param is not present. | N/A |
Sample Call:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data "description=I gotta brand new key" http://localhost:8080/threadfix/rest/scans/{scanId}/metadata/{metadataKeyId}/update
|
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 2,
"orderPosition": 1,
"description": "I gotta brand new key",
"title": "Scan Metadata Key"
}
} |
| Page Tree | ||
|---|---|---|
|