Queue Remote Provider Scan - API

This endpoint is only supported for the following scanners:

Checkmarx
Netsparker Enterprise

/rest/{version}/remoteproviders/{remoteProviderAppId}/queueScan

Descriptor	Value
HTTP Method	POST
Description	Queues a scan for the Remote Provider application. For Checkmarx: Uses the source code repository stored in the ThreadFix application it is mapped to. For Netsparker Enterprise: Requires a scan to have been imported from Netsparker.
Required Permission	Manage Remote Provider Scans
Version Introduced	2.5.0

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
incremental	Boolean	No	default=false; If true then Checkmarx will execute an incremental scan, where it only checks files that have changed since the last scan.
sync	Boolean	No	default=false; If true the call will wait until the scan is reported finished by the remote provider before returning.
branchName	String	No	The name of the branch in the source repository to pull. For Checkmarx only.
commitId	String	No	The ID of the commit in the source repository to pull. For Checkmarx only.
tag	String	No	The name of the Tag in the source repository to pull. For Checkmarx only.

Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'incremental=false&sync=true&branchName=master' http://localhost:8080/threadfix/rest/latest/remoteproviders/2/queueScan

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "10060"
}