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.

Create Metadata Key - API

/rest/{version}/metadataKeys/new


Descriptor

Value

HTTP Method

POST

Description

Creates a new Metadata Key.

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 POST Data Parameters

Parameter

Value

Required

Description

key

String

Yes

Name of the Metadata Key.

activeBooleanNoWhether the new key is immediately enabled.  Defaults to 'True'
typeStringYesType of Metadata Key.  Must be one of: 'Scan', 'Application'


Sample Call:


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:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 8,
        "active": true,
        "type": "SCAN",
        "key": "Version"
    }
}

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.