Deprecated - Create Scan Metadata Key - API

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 Introduced

2.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" } }

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.