Object

ScheduleItem

Exposes all of the scheduling data about a configured scan, such as the time and date when the scan is scheduled to run, and how frequently. When a scheduled scan is due to start, a Scan object is created based on the associated schedule item. Note that for recurring scans, all individual occurrences of the scan share a common schedule item.

Fields

id(ID!)
The unique identifier of the schedule item.
site(Site!)
The site on which scans created from this schedule item are performed.
schedule(Schedule!)
Information about the time at which scans created from this schedule item run, and their frequency.
scan_configurations([ScanConfiguration!]!)
A list of the default scan configurations used by scans created from this schedule item. Note that when creating a schedule item using the API, the default scan configuration for the site is not automatically assigned. Therefore, even if you want to use the default configuration, you need to explicitly set it when creating a schedule item.
has_run_more_than_once(Boolean)
Indicates whether a recurring scan created from this schedule item has run more than once.
scheduled_run_time(Timestamp)
The next time that a scan created from this schedule item is due to run.

Example

Query
query GetScheduleItem($id: ID!) {
  schedule_item(id: $id) {
    id
    schedule {
      rrule
      initial_run_time
    }
    scheduled_run_time
  }
}
Variables
{
  "id": "4"
}
Result
{
  "data": {
    "schedule_item": {
      "id": "4",
      "schedule": {
        "rrule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR,SU",
        "initial_run_time": "2020-04-1T12:00:00Z"
      },
      "scheduled_run_time": "2020-04-10T12:00:00Z"
    }
  }
}