As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Delete Scan - API

/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:

curl --insecure -H 'Accept: application/json' -H 'Authorization: APIKEY {apiKey}' -X DELETE http://localhost:8080/threadfix/rest/latest/scans/6/delete


Sample Output:


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

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.