Sign in

v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Site

Site Scan Schedule

Updates the specified scan schedule.

put/api/3/sites/{id}/scan_schedules/{scheduleId}

Path parameters

idinteger required

The identifier of the site.

The identifier of the site.

scheduleIdinteger required

The identifier of the scan schedule.

Example:9

The identifier of the scan schedule.

Request body

durationstring

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:

ValueDescription
PThe duration designator. It must be placed at the start of the duration representation.
DThe day designator that follows the value for the number of days.
TThe time designator that precedes the time portion of the representation.
HThe hour designator that follows the value for the number of hours.
MThe minute designator that follows the value for the number of minutes.
For example, "P5DT10H30M" represents a duration of "5 days, 10 hours, and 30 minutes". Each duration designator is optional; however, at least one must be specified and it must be preceded by the "P" designator.
enabledboolean required

Flag indicating whether the scan schedule is enabled.

idobject

The identifier of the scan schedule.

nextRuntimesstring[]

List the next 10 dates in the future the schedule will launch.

onScanRepeat'restart-scan' | 'resume-scan' required

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:

ValueDescription
restart-scanStops the previously-paused scan and launches a new scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched.
resume-scanResumes the previously-paused scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched.
scanEngineIdinteger

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.

scanNamestring

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.

scanTemplateIdstring

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.

startstring date-time required

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.

Example request

{
  "assets": {
    "excludedAssetGroups": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    },
    "excludedTargets": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    },
    "includedAssetGroups": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    },
    "includedTargets": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    }
  },
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "repeat": {
    "every": "date-of-month",
    "interval": 1
  },
  "start": "2018-03-01T04:31:56Z"
}

Response

OK