Schedule a Dynamic Analysis
You can schedule a Dynamic Analysis to run one time, either immediately after you submit it or on a specific date, or on a recurring schedule. You can also schedule the analysis to pause and resume on specific days or times.
To configure a schedule with the REST API, see Dynamic Analysis REST API.
Because API Scanning scans each API specification quickly, Veracode recommends that you do not pause and resume the analysis.
Schedule a one-time scan
You can schedule a Dynamic Analysis in the Veracode Platform to run only one time. When you are ready to run the analysis, you can start it immediately or schedule it to run on a date up to 90 days in the future. You can also configure the analysis to run on a recurring schedule.
You can also a schedule an analysis with the REST API.
Before you begin:
Ensure you have:
- A Veracode account with the Creator, Submitter, or Security Lead role.
- If you want your analysis to automatically pause when it encounters an authentication error, your account must have the Auto-Pause feature. You can configure the analysis to resume automatically or manually. To enable this feature, contact Veracode Technical Support.
- Created a Dynamic Analysis of a web application or API and selected Schedule at the bottom of the page in the Veracode Platform.
To complete this task:
-
On the Dynamic Analysis Schedule and Prescan page, for Frequency, select Once.
-
If you are configuring an existing analysis that has already run, and you want to run it again using the updated schedule, select Scan again with this configuration and updated start date and time. If you are creating a new analysis, you do not see this option.
-
Optionally, to run a prescan before the analysis starts, turn on Prescan. Because a prescan requires two hours to run, the start time must be at least two hours in the future, or Prescan is disabled. After you update the start time, Prescan is enabled.
-
For Start, select the date and time when you want the analysis to start.
-
For Analysis Duration, enter the maximum number of hours or days that you want the analysis to run.
-
In the Pause and Resume section, if your account has the Auto-Pause feature, you see the Pause automatically and resume option. If your account does not have this feature, you see an Off option, and you can ignore this step.
Select one of the following options:
- manually: the analysis remains paused until you fix the error and resume it manually. The default.
- automatically: after you fix the error, you must wait for the analysis to resume. You cannot resume the analysis manually. The analysis resumes during the next scheduled run.
-
To schedule the analysis to pause automatically, so that it only runs on specific days or during specific times, select Pause. Then, select from the following options:
- on these days: pause the analysis on the selected days.
- during this period: pause the analysis every day during the selected period.
- on these days, during these periods: pause the analysis on the selected days, during the selected periods.
The analysis resumes automatically, outside the configured pause schedule.
-
Optionally, to review a summary of the schedule, select Preview Schedule.
-
To save the schedule and continue to the next steps, select Review and Submit.
Schedule a recurring scan
You can configure a recurring schedule of your Dynamic Analysis in the Veracode Platform to run on a set day and time each week or month. You can also schedule the analysis to automatically pause and resume at specific times, such as IT downtimes or high-traffic timeframes.
You only have to configure the pause and resume schedule once, and it recurs automatically without any further manual intervention for the duration of the analysis. You can edit the pause and resume schedule or turn it off at any time.
You can also schedule a recurring analysis with the REST API.
Before you begin:
Ensure you have:
- A Veracode account with the Creator, Submitter, or Security Lead role.
- If you want your analysis to automatically pause when it encounters an authentication error, your account must have the Auto-Pause feature. You can configure the analysis to resume automatically or manually. To enable this feature, contact Veracode Technical Support.
- Created a Dynamic Analysis of a web application or API and selected Schedule at the bottom of the page in the Veracode Platform.
To complete this task:
-
On the Dynamic Analysis Schedule and Prescan page, for Frequency, select Recurring.
-
Optionally, to run a prescan before the analysis starts, turn on Prescan. Because a prescan requires two hours to run, the start time must be at least two hours in the future, or Prescan is disabled. After you update the start time, Prescan is enabled.
-
For Start, enter the date when you want the schedule to start, or select the calendar icon and select a date. If you set the start day for the 28th or later, the analysis starts on the last day of the month.
-
From the Recur dropdown, select Weekly or Monthly.
-
For Every, enter the recurrence frequency in weeks or months.
-
From the On dropdown menu, select the day on which you want the scan to recur.
-
For End After, enter the number of weeks or months that you want the recurrence schedule to last.
-
For Start, select the date and time when you want the analysis to start.
-
For Analysis Duration, enter the maximum number of hours or days that you want the analysis to run.
-
In the Pause and Resume section, if your account has the Auto-Pause feature, you see the Pause automatically and resume option. If your account does not have this feature, you see an Off option, and you can ignore this step.
Select one of the following options:
- manually: the analysis remains paused until you fix the error and resume it manually. The default.
- automatically: after you fix the error, you must wait for the analysis to resume. You cannot resume the analysis manually. The analysis resumes during the next scheduled run.
-
To schedule the analysis to pause automatically, so that it only runs on specific days or during specific times, select Pause. Then, select from the following options:
- on these days: pause the analysis on the selected days.
- during this period: pause the analysis every day during the selected period.
- on these days, during these periods: pause the analysis on the selected days, during the selected periods.
The analysis resumes automatically, outside the configured pause schedule.
-
Optionally, to review a summary of the schedule, select Preview Schedule.
-
To save the schedule and continue to the next steps, select Review and Submit.
Check the status of a scheduled scan
After you submit the Dynamic Analysis, the summary of the schedule displays at the top of the summary of the Dynamic Analysis. You receive an email notification of any verification errors and also when the Dynamic Analysis is complete.
From the All Dynamic Analysis Scans page, you can review the schedule of any Dynamic Analysis by hovering over the clock icon in the row for that Dynamic Analysis. The respective schedule displays, providing at-a-glance information. If a Dynamic Analysis is scheduled to run only once or if the recurrence timeframe has ended, you can verify the status of the schedule to see if any more occurrences are scheduled.
To complete this task:
- In the Veracode Platform, select Scans & Analysis > Dynamic Analysis.
- In the list of All Dynamic Analysis Scans, select Edit from the action menu in the row of the Dynamic Analysis that you want to check.
- At the bottom of the Edit page, select Schedule. In the Dynamic Analysis Scheduling section, you can see if the analysis is scheduled.
- If the analysis is scheduled and you want to cancel it, select Cancel schedule and save for later.
Stop a scheduled scan
You can stop a Dynamic Analysis that runs on a schedule. When stopping the scan, you can choose to save or delete the available scan results.
To complete this task:
-
In the Veracode Platform, select Scans & Analysis > Dynamic Analysis. The All Dynamic Analyses page opens.
-
Locate the row for the Dynamic Analysis you want to stop.
-
From Actions, select Stop Analysis.
-
Select to stop the analysis and to either save or delete the results.
-
Select View Results in the Actions column to review the results.
If you want to run the Dynamic Analysis again with the same configuration, edit the schedule to rerun the scan on your new selected day and time.
Manually resume a paused scan
You can manually resume a scheduled Dynamic Analysis that is paused due to an authentication error.
For example, if an analysis uses invalid credentials to sign in to a target URL, after multiple attempts, the analysis changes to a paused state. After you update the credentials in the analysis configuration for a web application or API, you can manually resume the analysis. The analysis resumes its schedule and uses the updated credentials to sign in to the URL.
Before you begin:
Ensure you have:
- Enabled the Auto-Pause feature for your Veracode account. To enable this feature, contact Veracode Technical Support.
- A Veracode account with the Creator, Submitter, or Security Lead role.
- Created a Dynamic Analysis that is scheduled to run one-time or on a recurring schedule. In the Veracode Platform, on the Schedule page for the analysis, in the Pause and Resume section, ensure Pause automatically and resume is set to manually.
- Resolved the authentication errors.
To complete this task:
- In the Veracode Platform, select Scans & Analysis > Dynamic Analysis.
- On the All Dynamic Analyses page, locate the row for the analysis you want to resume.
- From Actions , select Resume Analysis. When you scheduled the analysis, if you set Pause automatically and resume to resume automatically, the Resume Analysis action is disabled. The analysis resumes and continues to run on its schedule.