Using Pipeline Scan Timeouts with the REST API

This use case scenario provides the Pipeline Scan REST API command and payload for specifying a user-defined timeout for scanning.

Use this command to set a timeout in a scan:

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

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

{
  "binary_name": "verademo.war",
  "binary_size": 6577398,
  "binary_hash": "48c96bf1ff8b47316683c99376b67b455f0e4a2d9705323fa3bcbe71afe350c7",
  "project_name": "verademo",
  "project_uri": "https://github.com/veracode/verademo", 
  "dev_stage": "DEVELOPMENT",
  "scan_timeout": 32
}
 

The scan_timeout is an integer value that specifies the timeout period in minutes. The minimum value is 0 and the maximum is 60.