Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/tasks/requestScanAgentKey

 


Descriptor

Value

HTTP Method

GET

Description

Request a Secure Scan Agent Key.  This key is used to request scan agent tasks and prevent multiple scan agents from interacting with the same task.

Required Permission

Read Access (Any Role)

Version Introduced2.4.0
 


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

 


Sample Call:

Code Block
themeEclipse
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/tasks/requestScanAgentKey?apiKey={apiKey}

Sample Output:


Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "yMFCvtcmBtAARYS5QX8x54zvMruNLIvNMzqMI44K4JG8"
}
 



Page Tree
rootTasks API