Mutation

create_scan_freeze_window

Creates a new Scan Freeze Window.

Arguments

input: CreateScanFreezeWindowInput!


Input Fields

name(): String!
The name of the scan freeze window.
description(): String
The description of the scan freeze window.
active_period(): DateRangeInput
The period during which the scan freeze window is active.
timezone(): Timezone!
The IANA Time zone code for which the scan freeze window's schedule is defined for.
schedule(): ScanFreezeScheduleInput!
The schedule of individual time slots within a week during which scans are frozen.
site_tree_selection(): [ScanFreezeWindowSiteTreeSelectionInput!]!
All sites and folders that this scan freeze window applies to.
enabled(): Boolean!
Whether the scan freeze window is enabled.

Return Fields

scan_freeze_window(): ScanFreezeWindow!

Example

Query 
mutation CreateScanFreezeWindow($input: CreateScanFreezeWindowInput!) {
  create_scan_freeze_window(input: $input) {
    scan_freeze_window {
      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
      }
    }
  }
}
Variables 
{
  "input": {
    "name": "Business Hours Freeze",
    "description": "Prevent scans during business hours",
    "enabled": true,
    "timezone": "Europe/London",
    "active_period": {
      "start_inclusive": "2025-01-01",
      "end_inclusive": "2025-12-31"
    },
    "schedule": {
      "time_slots": [
        {
          "begin_day": "mon",
          "begin_time": "09:00",
          "end_day": "mon",
          "end_time": "17:00"
        },
        {
          "begin_day": "tue",
          "begin_time": "09:00",
          "end_day": "tue",
          "end_time": "17:00"
        },
        {
          "begin_day": "wed",
          "begin_time": "09:00",
          "end_day": "wed",
          "end_time": "17:00"
        },
        {
          "begin_day": "thu",
          "begin_time": "09:00",
          "end_day": "thu",
          "end_time": "17:00"
        },
        {
          "begin_day": "fri",
          "begin_time": "09:00",
          "end_day": "fri",
          "end_time": "17:00"
        }
      ]
    },
    "site_tree_selection": [
      {
        "id": "5"
      },
      {
        "id": "12"
      }
    ]
  }
}
Result 
{
  "data": {
    "create_scan_freeze_window": {
      "scan_freeze_window": {
        "id": "2",
        "name": "Business Hours Freeze",
        "description": "Prevent scans during business hours",
        "enabled": true,
        "timezone": "Europe/London",
        "active_period": {
          "start_inclusive": "2025-01-01",
          "end_inclusive": "2025-12-31"
        },
        "schedule": {
          "time_slots": [
            {
              "begin_day": "mon",
              "begin_time": "09:00",
              "end_day": "mon",
              "end_time": "17:00"
            },
            {
              "begin_day": "tue",
              "begin_time": "09:00",
              "end_day": "tue",
              "end_time": "17:00"
            },
            {
              "begin_day": "wed",
              "begin_time": "09:00",
              "end_day": "wed",
              "end_time": "17:00"
            },
            {
              "begin_day": "thu",
              "begin_time": "09:00",
              "end_day": "thu",
              "end_time": "17:00"
            },
            {
              "begin_day": "fri",
              "begin_time": "09:00",
              "end_day": "fri",
              "end_time": "17:00"
            }
          ]
        },
        "site_tree_selection": [
          {
            "id": "5"
          },
          {
            "id": "12"
          }
        ]
      }
    }
  }
}