As we reach the end of September 2024, ThreadFix version 3.x on-premises has officially reached its End-of-Life. Therefore, there is no longer support or updates for this version of the product. We have fully transitioned our product and development teams to focus ThreadFix SaaS and migrating all customers over from the on-premises versions. Our Customer Success and Support teams are here to help you in migrating to ThreadFix SaaS and maximizing the value you see from this improved offering from Coalfire. This is the next phase of ThreadFix and our team is looking forward to continuing to support you on this journey.

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

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.