Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 3.57 KB

ScanSchedule.md

File metadata and controls

19 lines (16 loc) · 3.57 KB

Rapid7VmConsole::ScanSchedule

Properties

Name Type Description Notes
assets ScheduledScanTargets Allows one or more assets defined within the site to be scanned for this scan schedule. This property is only supported for static sites. When this property is `null`, or not defined in schedule, then all assets defined in the static site will be scanned. [optional]
duration String Specifies the maximum duration the scheduled scan is allowed to run. Scheduled scans that do not complete within specified duration will be paused. The scan duration are represented by the format `"P[n]DT[n]H[n]M"`. In these representations, the [n] is replaced by a value for each of the date and time elements that follow the [n].The following table describes each supported value: Value
enabled BOOLEAN Flag indicating whether the scan schedule is enabled.
id Integer The identifier of the scan schedule. [optional]
links Array<Link> [optional]
next_runtimes Array<String> List the next 10 dates in the future the schedule will launch. [optional]
on_scan_repeat String Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration. The following table describes each supported value: Value
repeat Repeat Settings for repeating a scheduled scan. [optional]
scan_engine_id Integer The identifier of the scan engine to be used for this scan schedule. If not set, the site's assigned scan engine will be used. [optional]
scan_name String A user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Scan names must be unique within the site's scan schedules. [optional]
scan_template_id String The identifier of the scan template to be used for this scan schedule. If not set, the site's assigned scan template will be used. [optional]
start String The scheduled start date and time. Date is represented in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time.