As we reach the end of September 2024, ThreadFix version 3.x on-premises has officially reached its End-of-Life. Therefore, there is no longer support or updates for this version of the product. We have fully transitioned our product and development teams to focus ThreadFix SaaS and migrating all customers over from the on-premises versions. Our Customer Success and Support teams are here to help you in migrating to ThreadFix SaaS and maximizing the value you see from this improved offering from Coalfire. This is the next phase of ThreadFix and our team is looking forward to continuing to support you on this journey.

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

Version 1 Next »

Deprecated as of version 2.7.5. Use Create Metadata Key 3.0 - API instead.


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


Descriptor

Value

HTTP Method

POST

Description

Creates a new scan metadata key

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.

Request POST Data Parameters

Parameter

Value

Required

Description

Available Values

key

String

Yes

The name to assign the new metadata key.

N/A

active

String

No

Sets the meta data key to active or inactive.

“TRUE”, “FALSE”

Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data "key=Port Key Title&active=true" http://localhost:8080/threadfix/rest/latest/customize/scanmetadata/keys/new


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 2,
        "active": true,
        "key": "Port Key"
    }
}

  • No labels