ApiAtlasSnapshotScheduleView

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-api-atlas-snapshot-schedule-view-schema.json",
  "title": "ApiAtlasSnapshotScheduleView",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-legacy-backup-api-openapi.yml#/components/schemas/ApiAtlasSnapshotScheduleView",
  "properties": {
    "clusterCheckpointIntervalMin": {
      "description": "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.",
      "enum": [
        15,
        30,
        60
      ],
      "format": "int32",
      "type": "integer"
    },
    "clusterId": {
      "description": "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.",
      "pattern": "^([a-f0-9]{24})$",
      "type": "string"
    },
    "dailySnapshotRetentionDays": {
      "description": "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.",
      "enum": [
        0,
        3,
        4,
        5,
        6,
        7,
        15,
        30,
        60,
        90,
        120,
        180,
        360
      ],
      "format": "int32",
      "type": "integer"
    },
    "groupId": {
      "description": "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.",
      "pattern": "^([a-f0-9]{24})$",
      "readOnly": true,
      "type": "string"
    },
    "links": {
      "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.",
      "items": {
        "$ref": "#/$defs/Link"
      },
      "readOnly": true,
      "type": "array"
    },
    "monthlySnapshotRetentionMonths": {
      "description": "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        18,
        24,
        36
      ],
      "format": "int32",
      "type": "integer"
    },
    "pointInTimeWindowHours": {
      "description": "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot.",
      "format": "int32",
      "type": "integer"
    },
    "snapshotIntervalHours": {
      "description": "Number of hours that must elapse before taking another snapshot.",
      "enum": [
        6,
        8,
        12,
        24
      ],
      "format": "int32",
      "type": "integer"
    },
    "snapshotRetentionDays": {
      "description": "Number of days that MongoDB Cloud must keep recent snapshots.",
      "enum": [
        2,
        3,
        4,
        5
      ],
      "format": "int32",
      "type": "integer"
    },
    "weeklySnapshotRetentionWeeks": {
      "description": "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        12,
        16,
        20,
        24,
        52
      ],
      "format": "int32",
      "type": "integer"
    }
  },
  "required": [
    "clusterCheckpointIntervalMin",
    "clusterId",
    "dailySnapshotRetentionDays",
    "groupId",
    "monthlySnapshotRetentionMonths",
    "pointInTimeWindowHours",
    "snapshotIntervalHours",
    "snapshotRetentionDays",
    "weeklySnapshotRetentionWeeks"
  ],
  "type": "object",
  "$defs": {
    "Link": {
      "properties": {
        "href": {
          "description": "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.",
          "type": "string"
        },
        "rel": {
          "description": "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}