Versions Compared

Key

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

/rest/{version}/scans/{scanId}/delete


Descriptor

Value

HTTP Method

DELETE

Description

Queues the specified scan for deletion.  You can monitor its deletion progress using the "Check Pending Scan Status" REST call.

Required Permission

Upload Scans 

Version Introduced2.5.1.17


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}' -X DELETE http://localhost:8080/threadfix/rest/latest/scans/6/delete


Sample Output:


Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Successfully queued scan to be deleted.",
    "links": [
        {
            "method": "GET",
            "rel": "related",
            "href": "http://localhost:8080/threadfix/rest/applications/1/pendingScan/17/status"
        }
    ]
}


Page Tree
rootScans API