Update Task Status - API

/rest/{version}/tasks/taskStatusUpdate

Descriptor	Value
HTTP Method	POST
Description	Sends a status update to ThreadFix for the Scan Agent Task. You can view these updates on the Scan Agent Tasks page.
Required Permission	Manage Scan Agents
Version Introduced	2.4.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
scanQueueTaskId	Integer	Yes	ID for the Scan Agent Task to update.
message	String	Yes	The status update message.
scanAgentSecureKey	String	Yes	A Secure Scan Agent Key obtained from the “Request Scan Agent Key” call. Must be the same one used to assign the Task from the queue.
secureTaskKey	String	Yes	The Secure Task Key that was returned when the Task was assigned from the queue.

Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'scanQueueTaskId=1&message=This task is still in progress&scanAgentSecureKey=yMFCvtcmBtAARYS5QX8x54zvMruNLIvNMzqMI44K4JG8&secureTaskKey=KVS1TiifaYeILnchqbdmU24JEyljgNy0NTOgvSLzS3Y' http://localhost:8080/threadfix/rest/latest/tasks/taskStatusUpdate

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Successfully updated ScanQueueTask"
}