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.

List Scan Metadata Keys - API

Deprecated as of version 2.7.5. Use Get Metadata Keys - API instead.

/rest/{version}/customize/scanmetadata/keys/index


Descriptor

Value

HTTP Method

GET

Description

Retrieves a list of scan metadata keys

Required Permission

Manage Scan Metadata Keys

Version Introduced2.7.1


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.


Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X GET http://localhost/threadfix/rest/latest/customize/scanmetadata/keys/index


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 1,
            "active": true,
            "key": "I Gotta Brand New Pair of Rollerskates"
        },
        {
            "id": 2,
            "active": true,
            "key": "You Gotta Brand New Key"
        }
    ]
}

www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.