Group

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-group-schema.json",
  "title": "Group",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-projects-api-openapi.yml#/components/schemas/Group",
  "properties": {
    "clusterCount": {
      "description": "Quantity of MongoDB Cloud clusters deployed in this project.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "created": {
      "description": "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.",
      "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"
    },
    "name": {
      "description": "Human-readable label that identifies the project included in the MongoDB Cloud organization.",
      "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$",
      "type": "string"
    },
    "orgId": {
      "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.",
      "pattern": "^([a-f0-9]{24})$",
      "type": "string"
    },
    "regionUsageRestrictions": {
      "default": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
      "description": "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n`COMMERCIAL_FEDRAMP_REGIONS_ONLY`: Only allows deployments in FedRAMP Moderate regions.\n\n`GOV_REGIONS_ONLY`: Only allows deployments in GovCloud regions.",
      "enum": [
        "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
        "GOV_REGIONS_ONLY"
      ],
      "type": "string"
    },
    "tags": {
      "description": "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.",
      "items": {
        "$ref": "#/$defs/ResourceTag"
      },
      "type": "array"
    },
    "withDefaultAlertsSettings": {
      "default": true,
      "description": "Flag that indicates whether to create the project with default alert settings.",
      "type": "boolean"
    }
  },
  "required": [
    "clusterCount",
    "created",
    "name",
    "orgId"
  ],
  "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"
    },
    "ResourceTag": {
      "description": "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.",
      "properties": {
        "key": {
          "description": "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "value": {
          "description": "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "key",
        "value"
      ],
      "title": "Resource Tag",
      "type": "object"
    }
  }
}