v1/scan/stopscan

This API endpoint is used to stop an ongoing scan by providing the scan ID. The scan_id parameter is an array of scan IDs.

Request URL

curl -i -X POST "https://api.securitysurface.com/v1/scan/stopscan" \
-H "apikey: your_api_key" \
-H "Content-Type: application/json" \
-d '{"scan_id":["faca88f7-****-****-****-c0f83848b4a9"]}'

Replace your_api_key with your actual API key. The scan_id parameter is an array of scan IDs.

Request Parameters

Parameter Type Location Required Description
scan_id array body Yes An array of scan IDs to be stopped

Response Data 

{
    "status": "ss_success",
    "msg": "Scan task has been stopped successfully."
}