As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

/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 Introduced2.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:


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


Sample Output:


{
    "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"
        }
    ]
}

  • No labels