Create a Dynamic Analysis with a Pause and Resume Schedule Using the REST API

Veracode APIs

Publication
Veracode APIs
Edition date
2023-01-27
Last publication
2023-01-27T02:45:54.600583

You can use the Dynamic Analysis API to create an analysis that pauses and resumes scanning at specific times.

To complete this task:

  1. Enter values for the scan_config_request, schedule, and scan_blackout_schedule properties in the JSON file.

  2. Run this command:

    http --auth-type=veracode_hmac POST "https://api.veracode.com/was/configservice/v1/analyses" < input.json
    

This is an example of a Dynamic Analysis that contains a pause and resume time frame between 9:00pm and 11:00pm:

{
  "name": "Name-of-Your-Dynamic-Analysis",
  "scans": [
    {
      "scan_config_request": {
        "target_url": {
          "url": "http://www.example.com"
        }
      }
    }
  ],
  "schedule": {
    "start_date": "2019-09-27T16:49:00-04:00",
    "duration": {
      "length": 1,
      "unit": "DAY"
    },
    "scan_blackout_schedule": {
      "blackout_type": "THESE_HOURS",
      "blackout_start_time": "21:00",
      "blackout_end_time": "23:00",
      "blackout_days": null
    }
  }
}