Starting a Pipeline Scan with the REST API

Veracode APIs

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

Use this command to start a scan:

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

You obtain the scan_id from the results 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:

{
	"scan_status": "STARTED"
}