SystemStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-system-status-schema.json",
  "title": "SystemStatus",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-root-api-openapi.yml#/components/schemas/SystemStatus",
  "properties": {
    "apiKey": {
      "$ref": "#/$defs/ApiKey"
    },
    "appName": {
      "description": "Human-readable label that identifies the service from which you requested this response.",
      "enum": [
        "MongoDB Atlas"
      ],
      "readOnly": true,
      "type": "string"
    },
    "build": {
      "description": "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.",
      "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"
    },
    "throttling": {
      "description": "Flag that indicates whether someone enabled throttling on this service.",
      "readOnly": true,
      "type": "boolean"
    }
  },
  "required": [
    "apiKey",
    "appName",
    "build",
    "throttling"
  ],
  "type": "object",
  "$defs": {
    "AccessListItemView": {
      "properties": {
        "cidrBlock": {
          "description": "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.",
          "pattern": "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$",
          "readOnly": true,
          "type": "string"
        },
        "ipAddress": {
          "description": "IP address included in the API access list.",
          "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$",
          "readOnly": true,
          "type": "string"
        }
      },
      "required": [
        "ipAddress"
      ],
      "type": "object"
    },
    "ApiKey": {
      "description": "Details contained in one API key.",
      "properties": {
        "accessList": {
          "description": "List of network addresses granted access to this API using this API key.",
          "items": {
            "$ref": "#/$defs/AccessListItemView"
          },
          "readOnly": true,
          "type": "array"
        },
        "id": {
          "description": "Unique 24-hexadecimal digit string that identifies this organization API key.",
          "pattern": "^([a-f0-9]{24})$",
          "readOnly": true,
          "type": "string"
        },
        "publicKey": {
          "description": "Public API key value set for the specified organization API key.",
          "maxLength": 8,
          "minLength": 8,
          "readOnly": true,
          "type": "string"
        },
        "roles": {
          "description": "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.",
          "items": {
            "$ref": "#/$defs/CloudAccessRoleAssignment"
          },
          "readOnly": true,
          "type": "array"
        }
      },
      "readOnly": true,
      "required": [
        "accessList",
        "id",
        "publicKey",
        "roles"
      ],
      "type": [
        "object",
        "null"
      ]
    },
    "CloudAccessRoleAssignment": {
      "description": "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.",
      "properties": {
        "groupId": {
          "description": "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or `orgId` but not both in the same request.",
          "maxLength": 24,
          "minLength": 24,
          "pattern": "^([a-f0-9]{24})$",
          "type": "string"
        },
        "orgId": {
          "description": "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or `groupId` but not both in the same request.",
          "maxLength": 24,
          "minLength": 24,
          "pattern": "^([a-f0-9]{24})$",
          "type": "string"
        },
        "roleName": {
          "description": "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.",
          "type": "string"
        }
      },
      "title": "Role Assignment",
      "type": "object"
    },
    "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"
    }
  }
}