Object

ScanFreezeWindow

A scan freeze window that prevents scans from running during specified time periods.

Fields

active_period(): DateRange
The period during which the scan freeze window is active.
description(): String
The description of the scan freeze window.
enabled(): Boolean!
Whether the scan freeze window is enabled.
id(): ID!
The unique identifier of the scan freeze window.
name(): String!
The name of the scan freeze window.
schedule(): ScanFreezeSchedule!
The schedule of individual time slots within a week during which scans are frozen.
The sites and folders that this scan freeze window applies to.
timezone(): Timezone!
The IANA time zone code for which the scan freeze window's schedule is defined for.

Example

Query
query GetScanFreezeWindows($offset: Int, $limit: Int) {
  scan_freeze_windows(offset: $offset, limit: $limit) {
    items {
      id
      name
      description
      enabled
      timezone
      active_period {
        start_inclusive
        end_inclusive
      }
      schedule {
        time_slots {
          begin_day
          begin_time
          end_day
          end_time
        }
      }
      site_tree_selection {
        id
      }
    }
    total_count
  }
}
Variables
{
  "offset": 0,
  "limit": 10
}
Result
{
  "data": {
    "scan_freeze_windows": {
      "items": [
        {
          "id": "1",
          "name": "Weekend Maintenance Window",
          "description": "Prevent scans during weekend maintenance",
          "enabled": true,
          "timezone": "America/New_York",
          "active_period": {
            "start_inclusive": "2025-01-01",
            "end_inclusive": "2025-12-31"
          },
          "schedule": {
            "time_slots": [
              {
                "begin_day": "sat",
                "begin_time": "00:00",
                "end_day": "sun",
                "end_time": "23:00"
              }
            ]
          },
          "site_tree_selection": [
            {
              "id": "10"
            },
            {
              "id": "15"
            }
          ]
        }
      ],
      "total_count": 1
    }
  }
}