Versions Compared

Key

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

/rest/{version}/scanner/

...

denyListAllowList/new

Descriptor

Value

HTTP Method

POST

Description

Creates a new deny list or read allow list entry for a scanner

Required Permission

Manage Vulnerability Types

Version Introduced

2.78.92


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

channelTypeId

Integer

Yes

The ID of the channel type.

channelTypeName

String

No*

The name of the channel type (e.g. Checkmarx, Black Duck, etc.).

  • Required if channelTypeId not used.

channelVulnerabilityId

Integer

Yes

The ID of the channel vulnerability

channelVulnerabilityName

String

No*

The name of the channel vulnerability. *Required if channelVulnerabilityId not used.


Sample Call:

Code Block
curl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {api_key}" -X POST --data 'channelTypeName=Checkmarx&channelVulnerabilityId=2871' http://localhost:8080/threadfix/rest/latest/scanner/denyListReadAllowListdenyListAllowList/new


Sample Output:


Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 8,
        "modifiedDate": 1575903777569,
        "active": true,
        "channelType": {
            "id": 25,
            "name": "Checkmarx",
            "url": "http://www.checkmarx.com",
            "version": "7.8",
            "isDenyListMode": true,
            "mappingFilterName": "Checkmarx",
            "customChannel": false,
            "allowed": true
        },
        "channelVulnerability": {
            "id": 2871,
            "channelType": {
                "id": 25,
                "name": "Checkmarx",
                "url": "http://www.checkmarx.com",
                "version": "7.8",
                "isDenyListMode": true,
                "mappingFilterName": "Checkmarx",
                "customChannel": false,
                "allowed": true
            },
            "userCreated": false,
            "name": "Use_of_Two_Argument_Form_of_Open",
            "code": "Use_of_Two_Argument_Form_of_Open",
            "vulnerabilityMapHistories": [],
            "genericVulnerability": {
                "id": 398,
                "name": "7PK - Code Quality",
                "customText": null,
                "displayId": 398,
                "displayIdPrefix": "CWE-398",
                "displayIdText": "398",
                "CweId": 398
            },
            "editableMapping": false
        }
    }
}

...