CustomZoneMappings

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-custom-zone-mappings-schema.json",
  "title": "CustomZoneMappings",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-global-clusters-api-openapi.yml#/components/schemas/CustomZoneMappings",
  "properties": {
    "customZoneMappings": {
      "description": "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.",
      "items": {
        "$ref": "#/$defs/ZoneMapping"
      },
      "type": "array"
    }
  },
  "required": [
    "customZoneMappings"
  ],
  "type": "object",
  "$defs": {
    "ZoneMapping": {
      "description": "Human-readable label that identifies the subset of a global cluster.",
      "properties": {
        "location": {
          "description": "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible.",
          "type": "string"
        },
        "zone": {
          "description": "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code.",
          "type": "string"
        }
      },
      "required": [
        "location",
        "zone"
      ],
      "title": "Global Cluster Zone",
      "type": "object"
    }
  }
}