Set Task Config - API

/rest/{version}/tasks/setTaskConfig

Descriptor	Value
HTTP Method	POST
Description	Uploads a Scan Agent configuration file to an application that will be used by default for tasks with the relevant scanner.
Required Permission	Manage Scan Agents
Version Introduced	2.3.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	Available Values
appId	Integer	Yes	The ID for the app to upload the file to.	N/A
scannerType	String	Yes	The scanner the file will be used as a base for.	“Acunetix WVS”, “AppSpider”, “Burp Suite Pro”, “Security AppScan Standard”, “Nessus”, “OWASP Zed Attack Proxy”, “WebInspect”
file	File	Yes	The file to upload. Note that ThreadFix will automatically upload it with a name that will allow it to be used as a default configuration file.	N/A

Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST -F 'appId=1' -F 'scannerType=OWASP ZED Attack Proxy' -F 'file=@path/to/file/zap.scanagtcfg' http://localhost:8080/threadfix/rest/latest/tasks/setTaskConfig

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Scan configuration for scanner: OWASP ZED Attack Proxy saved for appId: 1"
}