Canceling a Pipeline Scan with the REST API

This use case scenario provides the Pipeline Scan REST API command and payload for canceling a scan.

Use this command to cancel a scan:

 http --auth-type=veracode_hmac PUT "https://api.veracode.com/pipeline_scan/v1/scans/{scan_id}" < input.json        
      

Obtain the scan_id from the response of the POST to the /scans endpoint as described in Configuring a Pipeline Scan with the REST API.

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "scan_status": "CANCELLED"
}