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.

Change Blacklist/Whitelist Mode - API

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


This endpoint was deprecated in version ThreadFix version 2.8.2 and replaced with Change Deny List/Allow List Mode - API



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
Changes in 2.8.2Deprecated and replaced with Change Deny List/Allow List Mode - API


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

channelTypeIdIntegerYesThe ID of the channel type

channelTypeName

String

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:

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


Sample Output:


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

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.