Versions Compared

Key

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

/rest/{version}/metadataKeys?type={type}

Descriptor

Value

HTTP Method

GET

Description

Returns all Metadata Keys.  Can be filtered to a specific type.

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 GET URL Parameters

Parameter

Value

Required

Description

type

String

No

'Scan' or 'Application'.  Filters the Metadata Keys to only return that type.

Sample Call:

Code Block
languagebash
themeEclipse
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" http://localhost:8080/threadfix/rest/latest/metadataKeys?type=Application

Sample Output:

Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 4,
            "active": true,
            "type": "APPLICATION",
            "key": "Version"
        },
        {
            "id": 5,
            "active": true,
            "type": "APPLICATION",
            "key": "Region"
        },
        {
            "id": 6,
            "active": false,
            "type": "APPLICATION",
            "key": "Introduction"
        }
    ]
}

Page Tree
rootThreadFix API 3.0 - WIPX