GroupMaintenanceWindow

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-group-maintenance-window-schema.json",
  "title": "GroupMaintenanceWindow",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-maintenance-windows-api-openapi.yml#/components/schemas/GroupMaintenanceWindow",
  "properties": {
    "autoDeferOnceEnabled": {
      "description": "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. This setting controls the same underlying auto-deferral feature as the `/maintenanceWindow/autoDefer` endpoint. Use either this field (to set a specific value) or that endpoint (to toggle the current value). For most use cases, this field in the PATCH request is preferred because it allows setting an explicit value rather than toggling.",
      "type": "boolean"
    },
    "dayOfWeek": {
      "description": "One-based integer that represents the day of the week that the maintenance window starts.\n\n- `1`: Sunday.\n- `2`: Monday.\n- `3`: Tuesday.\n- `4`: Wednesday.\n- `5`: Thursday.\n- `6`: Friday.\n- `7`: Saturday.",
      "format": "int32",
      "maximum": 7,
      "minimum": 1,
      "type": "integer"
    },
    "hourOfDay": {
      "description": "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.",
      "format": "int32",
      "maximum": 23,
      "minimum": 0,
      "type": "integer"
    },
    "numberOfDeferrals": {
      "description": "Number of times the current maintenance event for this project has been deferred.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "protectedHours": {
      "$ref": "#/$defs/ProtectedHours"
    },
    "startASAP": {
      "description": "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance.",
      "type": "boolean"
    },
    "timeZoneId": {
      "description": "Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "dayOfWeek"
  ],
  "type": "object",
  "$defs": {
    "ProtectedHours": {
      "description": "Defines the a window where maintenance will not begin within.",
      "properties": {
        "endHourOfDay": {
          "description": "Zero-based integer that represents the end hour of the of the day that the maintenance will not begin in.",
          "format": "int32",
          "maximum": 23,
          "minimum": 0,
          "type": "integer"
        },
        "startHourOfDay": {
          "description": "Zero-based integer that represents the beginning hour of the of the day that the maintenance will not begin in.",
          "format": "int32",
          "maximum": 23,
          "minimum": 0,
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}