Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/scanner/blacklistWhitelist/setListMode
| Warning |
|---|
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 Introduced | 2.7.9 |
| Changes in 2.8.2 | Deprecated 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
PUTPOST Data Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
| channelTypeId | Integer | Yes | The ID of the channel type |
channelTypeName | StringYes | No* | The name of the channel type (e.g. Checkmarx, Black Duck, etc.). |
listMode | String | Yes | Accepted values are "blacklist" or "whitelist" |
Sample Call:
| Code Block | ||
|---|---|---|
| ||
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:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": "successfully updated list mode"
}
|
| Page Tree | ||
|---|---|---|
|