Queue Remote Provider Scan 3.0 - API

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

This endpoint is only supported for Netsparker Enterprise.

Descriptor	Value
HTTP Method	POST
Description	Queues a scan for the Remote Provider application. 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;
sync	Boolean	No	default=false; If true the call will wait until the scan is reported finished by the remote provider before returning.

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"
}