Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/metadataKeys/new
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Creates a new Metadata Key. |
Required Permission | Manage Metadata Keys. |
| Version Introduced | 2.7.5 |
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 |
|---|---|---|---|
key | String | Yes | Name of the Metadata Key. |
| active | Boolean | No | Whether the new key is immediately enabled. Defaults to 'True' |
| type | String | Yes | Type of Metadata Key. Must be one of: 'Scan', 'Application' |
Sample Call:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" -X POST --data "key=Version&type=Scan" http://localhost:8080/threadfix/rest/latest/metadataKeys/new
|
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 8,
"active": true,
"type": "SCAN",
"key": "Version"
}
} |
| Page Tree | ||
|---|---|---|
|