Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/scanner/blacklistWhitelist/setListMode


Descriptor

Value

HTTP Method

POST

Description

Allows user to change from current mode to new mode

Required Permission

Manage Vulnerability Types

Version Introduced2.7.9


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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


Request PUT Data Parameters

Parameter

Value

Required

Description

channelTypeIdIntegerYesThe ID of the channel type

channelTypeName

StringYes

No*

The name of the channel type (e.g. Checkmarx, Black Duck, etc.).
*Required if channelTypeId is not used.

listMode

String

Yes

Accepted values are "blacklist" or "whitelist"


Sample Call:

Code Block
themeEclipse
curl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {api_key}" -X POST --data 'channelTypeName=Checkmarx&listMode=whitelist' http://localhost:8080/threadfix/rest/scanner/blacklistWhitelist/setListMode


Sample Output:


Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "successfully updated list mode"
}


Page Tree
rootDefect Trackers API