Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/metadataKeys/{metadataKeyId}/update

Descriptor

Value

HTTP Method

POST

Description

Edits 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

No

New name for the Metadata Key.

active

Boolean

No

Set to 'True' to enable the key, set to 'False' to disable the key.

Sample Call:

Code Block
languagebash
themeEclipse
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" -X POST --data "key=Version (outdated)&active=false" http://localhost:8080/threadfix/rest/latest/metadataKeys/8/update

Sample Output:

Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 8,
        "active": false,
        "type": "SCAN",
        "key": "Version (outdated)"
    }
}

Page Tree
rootThreadFix API 3.0 - WIPX