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

Version 1 Next »

/rest/customize/scanmetadata/keys/new


Descriptor

Value

HTTP Method

POST

Description

Creates a new scan meta data key

Required Permission

Manage Scan Metadata Keys

Version Introduced2.7


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

name

String

Yes

The name to assign the new tag.

N/A

active

String

No

Sets the meta data key to active or inactive.

“TRUE”, “FALSE”

Sample Call:


curl --insecure -H 'Accept: application/json' -X POST --data "key=Metadata Key Title&active=true" http://localhost/threadfix/rest/v2.7/customize/scanmetadata/keys/new?apiKey={apiKey}


Sample Output:


{PLACEHOLDER ONLY!!! TO BE REPLACED WITH CORRECT RETURN MESSAGE!!
    "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"
        }
    ]
}

  • No labels