openapi: 3.0.1 info: description: "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the recommended authentication method and API keys are considered a legacy option.\n\nTo authenticate with a Service Account, first exchange its client ID and secret for an access token using the OAuth 2.0 Client Credentials flow. Atlas provides a token endpoint at `POST https://cloud.mongodb.com/api/oauth/token`, which returns a Bearer token that is reusable and valid for 1 hour (3600 seconds).\n\nFor example, to [return a list of your organizations](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs) with [cURL](https://en.wikipedia.org/wiki/CURL), first generate an access token and then use that token to call the same Atlas Administration API endpoint shown in the current example:\n\n```\nACCESS_TOKEN=$(curl -fsS --request POST https://cloud.mongodb.com/api/oauth/token \\\n --header \"Authorization: Basic $(printf '%s' \"${CLIENT_ID}:${CLIENT_SECRET}\" | base64 | tr -d '\\n')\" \\\n --header \"Content-Type: application/x-www-form-urlencoded\" \\\n --header \"Accept: application/json\" \\\n --data \"grant_type=client_credentials\" | jq -r '.access_token')\n\ncurl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"\n```\n\nIf your organization requires an IP access list for the Atlas Administration API, the token can be created from any IP address, but the API call that uses the token must originate from an allowed IP.\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/) (requires a Postman account)." license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration Access Tracking Clusters API version: '2.0' x-xgen-sha: 3d70e065843c008b9871ea7836c98c9de6f202f9 servers: - url: https://cloud.mongodb.com security: - ServiceAccounts: [] - DigestAuth: [] tags: - description: Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. name: Clusters paths: /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. operationId: listClusterDetails parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedOrgGroupView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Authorized Clusters in All Projects tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters listClusterDetails --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListClusterDetailsApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tListClusterDetailsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusterDetails x-xgen-method-verb-override: customMethod: false verb: listDetails /api/atlas/v2/groups/{groupId}/clusters: get: description: 'Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the List Flex Clusters endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: description: List Flex Clusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters operationId: listGroupClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - description: Flag that indicates whether to return Clusters with retain backups. in: query name: includeDeletedWithRetainedBackups schema: default: false type: boolean - description: Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility. in: header name: Use-Effective-Instance-Fields schema: default: false type: boolean responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/PaginatedClusterDescription20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Clusters in One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters listClusters --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClustersApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tListGroupClustersWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusters x-xgen-operation-id-override: listClusters post: description: 'Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Cluster Creator role. This feature is not available for serverless clusters. Please note that using an `instanceSize` of M2 or M5 will create a Flex cluster instead. Support for the `instanceSize` of M2 or M5 will be discontinued in January 2026. We recommend using the Create Flex Cluster API for such configurations moving forward. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: description: Create Flex Cluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster operationId: createGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Controls how hardware specification fields are returned in the response after cluster creation. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility. in: header name: Use-Effective-Instance-Fields schema: default: false type: boolean - description: Controls how `replicationSpecs` fields are returned in the response. When set to `true`, stores the client's view of `replicationSpecs` and returns it in `replicationSpecs`, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state. in: header name: Use-Effective-Fields-Replication-Specs schema: default: false type: boolean requestBody: content: application/vnd.atlas.2024-10-23+json: examples: Cluster: description: Cluster value: clusterType: SHARDED name: myCluster replicationSpecs: - regionConfigs: - analyticsAutoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M40 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true analyticsSpecs: diskSizeGB: 10 instanceSize: M40 nodeCount: 0 autoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M60 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true electableSpecs: diskSizeGB: 10 instanceSize: M60 nodeCount: 3 priority: 7 providerName: AWS readOnlySpecs: diskSizeGB: 10 instanceSize: M60 nodeCount: 0 regionName: US_EAST_1 zoneName: Zone 1 - regionConfigs: - analyticsAutoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M40 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true analyticsSpecs: diskSizeGB: 10 instanceSize: M30 nodeCount: 0 autoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M60 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true electableSpecs: diskSizeGB: 10 instanceSize: M40 nodeCount: 3 priority: 7 providerName: AWS readOnlySpecs: diskSizeGB: 10 instanceSize: M40 nodeCount: 0 regionName: US_EAST_1 zoneName: Zone 1 schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-version: '2024-10-23' description: Cluster to create in this project. required: true responses: '201': content: application/vnd.atlas.2024-10-23+json: schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-version: '2024-10-23' description: Created headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '402': $ref: '#/components/responses/paymentRequired' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Cluster in One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters createCluster --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tCreateGroupClusterWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" x-rolesRequirements: - Project Cluster Creator x-xgen-changelog: '2025-06-05': Fixed a bug that previously permitted users to configure multiple regionConfigs for the same region and cloud provider within a replicationSpec x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createGroupCluster x-xgen-operation-id-override: createCluster /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. operationId: listGroupClusterProviderRegions parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - description: Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters. in: query name: providers schema: items: type: string type: array - description: Cluster tier for which to retrieve the regions. in: query name: tier schema: type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedApiAtlasProviderRegionsView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Cloud Provider Regions tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters listClusterProviderRegions --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterProviderRegionsApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tListGroupClusterProviderRegionsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusterProviderRegions x-xgen-operation-id-override: listClusterProviderRegions /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: "Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. \n\nThis endpoint can also be used to upgrade Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) API or former M2/M5 clusters that have been migrated to Flex clusters, using `instanceSizeName` to “M2” or “M5” until January 2026. This functionality will be available until January 22, 2026, after which it will only be available for M0 clusters. Please use the Upgrade Flex Cluster endpoint instead." externalDocs: description: Upgrade Flex Cluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster operationId: upgradeGroupClusterTenantUpgrade parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest' description: Details of the shared-tier cluster upgrade in the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/LegacyAtlasCluster' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '402': $ref: '#/components/responses/paymentRequired' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Upgrade One Shared-Tier Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters upgradeTenantUpgrade --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpgradeGroupClusterTenantUpgradeApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tUpgradeGroupClusterTenantUpgradeWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" x-rolesRequirements: - Project Cluster Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgrade x-xgen-method-verb-override: customMethod: true verb: upgrade x-xgen-operation-id-override: upgradeTenantUpgrade /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: deprecated: true description: "This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the Upgrade Flex Cluster endpoint to upgrade Flex clusters.\n\n Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role." externalDocs: description: Upgrade Flex Cluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster operationId: upgradeGroupClusterTenantUpgradeToServerless parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ServerlessInstanceDescription' description: Details of the shared-tier cluster upgrade in the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ServerlessInstanceDescription' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '402': $ref: '#/components/responses/paymentRequired' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Upgrade One Shared-Tier Cluster to One Serverless Instance tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters upgradeClusterToServerless --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpgradeGroupClusterTenantUpgradeToServerlessApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tUpgradeGroupClusterTenantUpgradeToServerlessWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" x-rolesRequirements: - Project Cluster Manager x-sunset: '2025-02-05' x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgradeToServerless x-xgen-method-verb-override: customMethod: true verb: upgrade x-xgen-operation-id-override: upgradeClusterToServerless /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: description: 'Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the Delete Flex Cluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}' externalDocs: description: Delete Flex Cluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster operationId: deleteGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query name: retainBackups schema: type: boolean responses: '202': content: application/vnd.atlas.2023-02-01+json: x-xgen-version: '2023-02-01' description: Accepted headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Remove One Cluster from One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters deleteCluster --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterApiParams{}\n\thttpResp, err := client.ClustersApi.\n\t\tDeleteGroupClusterWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteGroupCluster x-xgen-operation-id-override: deleteCluster get: description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the Get Flex Cluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: description: Get Flex Cluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster operationId: getGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies this cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility. in: header name: Use-Effective-Instance-Fields schema: default: false type: boolean - description: Controls how `replicationSpecs` are returned in the response. When set to `true`, returns the client-specified view in `replicationSpecs` and the actual cluster state in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state. in: header name: Use-Effective-Fields-Replication-Specs schema: default: false type: boolean responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Cluster from One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters getCluster --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tGetGroupClusterWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupCluster x-xgen-operation-id-override: getCluster patch: description: 'Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster''s termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role or the Project Replica Set Manager role. You can''t modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}' operationId: updateGroupCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: 'Controls how hardware specification fields are returned in the response after cluster updates. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Note: When using this header with autoscaling enabled, MongoDB ignores `replicationSpecs` changes during updates. To intentionally override the `replicationSpecs`, disable this header.' in: header name: Use-Effective-Instance-Fields schema: default: false type: boolean - description: Controls how `replicationSpecs` fields are returned in the response. When set to `true`, stores the client's view of `replicationSpecs` and returns it in `replicationSpecs`, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in `effectiveReplicationSpecs`. When `false` (default), `replicationSpecs` contains the actual cluster state. in: header name: Use-Effective-Fields-Replication-Specs schema: default: false type: boolean requestBody: content: application/vnd.atlas.2024-10-23+json: schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-version: '2024-10-23' description: Cluster to update in the specified project. required: true responses: '200': content: application/vnd.atlas.2024-10-23+json: schema: $ref: '#/components/schemas/ClusterDescription20240805' x-xgen-version: '2024-10-23' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update One Cluster in One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters updateCluster --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tUpdateGroupClusterWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" x-rolesRequirements: - Project Cluster Manager - Project Replica Set Manager x-xgen-changelog: '2025-06-05': Fixed a bug that previously permitted users to configure multiple regionConfigs for the same region and cloud provider within a replicationSpec x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupCluster x-xgen-operation-id-override: updateCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: deprecated: true description: Returns the internal configuration of AutoScaling for sharded clusters. This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. operationId: autoGroupClusterScalingConfiguration parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies this cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescriptionAutoScalingModeConfiguration' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return Auto Scaling Configuration for One Sharded Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters autoScalingConfiguration --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AutoGroupClusterScalingConfigurationApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tAutoGroupClusterScalingConfigurationWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoGroupClusterScalingConfiguration x-xgen-method-verb-override: customMethod: 'True' x-xgen-operation-id-override: autoScalingConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: 'Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: getGroupClusterProcessArgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescriptionProcessArgs20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return Advanced Configuration Options for One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters getProcessArgs --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterProcessArgsApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tGetGroupClusterProcessArgsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterProcessArgs x-xgen-operation-id-override: getProcessArgs patch: description: 'Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. Deprecated versions: v2-{2023-01-01}' externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: updateGroupClusterProcessArgs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescriptionProcessArgs20240805' x-xgen-version: '2024-08-05' description: Advanced configuration details to add for one cluster in the specified project. required: true responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/ClusterDescriptionProcessArgs20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update Advanced Configuration Options for One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters updateProcessArgs --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterProcessArgsApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tUpdateGroupClusterProcessArgsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" x-rolesRequirements: - Project Cluster Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupClusterProcessArgs x-xgen-operation-id-override: updateProcessArgs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: description: 'Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster''s primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Deprecated versions: v2-{2023-01-01}' operationId: restartGroupClusterPrimaries parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-02-01+json: x-xgen-version: '2023-02-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Test Failover for One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters restartPrimaries --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RestartGroupClusterPrimariesApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tRestartGroupClusterPrimariesWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" x-rolesRequirements: - Project Cluster Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/restartGroupClusterPrimaries x-xgen-method-verb-override: customMethod: 'True' x-xgen-operation-id-override: restartPrimaries /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. operationId: getGroupClusterStatus parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ClusterStatus' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return Status of All Cluster Operations tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters getClusterStatus --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterStatusApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tGetGroupClusterStatusWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterStatus x-xgen-operation-id-override: getClusterStatus /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: post: description: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Support Access Manager role. operationId: grantGroupClusterMongoDbEmployeeAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies this cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/EmployeeAccessGrantView' x-xgen-version: '2024-08-05' description: Grant access level and expiration. required: true responses: '204': content: application/vnd.atlas.2024-08-05+json: x-xgen-version: '2024-08-05' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Grant MongoDB Employee Cluster Access for One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters grantMongoEmployeeAccess --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GrantGroupClusterMongoDbEmployeeAccessApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tGrantGroupClusterMongoDbEmployeeAccessWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess\" \\\n -d '{ }'" x-rolesRequirements: - Project Support Access Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantGroupClusterMongoDbEmployeeAccess x-xgen-operation-id-override: grantMongoEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not re-pin the FCV. operationId: pinGroupClusterFeatureCompatibilityVersion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies this cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2024-05-30+json: schema: $ref: '#/components/schemas/PinFCVView' x-xgen-version: '2024-05-30' description: Optional request parameters for tuning FCV pinning configuration. responses: '204': content: application/vnd.atlas.2024-05-30+json: x-xgen-version: '2024-05-30' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Pin Feature Compatibility Version for One Cluster in One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters pinFeatureCompatibilityVersion --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.PinGroupClusterFeatureCompatibilityVersionApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tPinGroupClusterFeatureCompatibilityVersionWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinGroupClusterFeatureCompatibilityVersion x-xgen-operation-id-override: pinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: post: description: Revokes a previously granted MongoDB employee cluster access. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Support Access Manager role. operationId: revokeGroupClusterMongoDbEmployeeAccess parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies this cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '204': content: application/vnd.atlas.2024-08-05+json: x-xgen-version: '2024-08-05' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Revoke MongoDB Employee Cluster Access for One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters revokeMongoEmployeeAccess --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RevokeGroupClusterMongoDbEmployeeAccessApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tRevokeGroupClusterMongoDbEmployeeAccessWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess\" \\\n -d '{ }'" x-rolesRequirements: - Project Support Access Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeGroupClusterMongoDbEmployeeAccess x-xgen-operation-id-override: revokeMongoEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. operationId: unpinGroupClusterFeatureCompatibilityVersion parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies this cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '204': content: application/vnd.atlas.2024-05-30+json: x-xgen-version: '2024-05-30' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '402': $ref: '#/components/responses/paymentRequired' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Unpin Feature Compatibility Version for One Cluster in One Project tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters unpinFeatureCompatibilityVersion --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UnpinGroupClusterFeatureCompatibilityVersionApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tUnpinGroupClusterFeatureCompatibilityVersionWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinGroupClusterFeatureCompatibilityVersion x-xgen-operation-id-override: unpinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: requestGroupSampleDatasetLoad parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster into which you load the sample dataset. in: path name: name required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '201': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/SampleDatasetStatus' x-xgen-version: '2023-01-01' description: Created headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Load Sample Dataset into One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters requestSampleDatasetLoad --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RequestGroupSampleDatasetLoadApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tRequestGroupSampleDatasetLoadWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/requestGroupSampleDatasetLoad x-xgen-method-verb-override: customMethod: true verb: request x-xgen-operation-id-override: requestSampleDatasetLoad /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: getGroupSampleDatasetLoad parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal digit string that identifies the loaded sample dataset. in: path name: sampleDatasetId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/SampleDatasetStatus' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return Status of Sample Dataset Load for One Cluster tags: - Clusters x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api clusters getSampleDatasetLoad --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupSampleDatasetLoadApiParams{}\n\tsdkResp, httpResp, err := client.ClustersApi.\n\t\tGetGroupSampleDatasetLoadWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupSampleDatasetLoad x-xgen-operation-id-override: getSampleDatasetLoad components: schemas: LegacyAtlasCluster: description: Group of settings that configure a MongoDB cluster. properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig` to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: Reconfiguring a Replica Set during a regional outage url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set format: date-time type: string advancedConfiguration: $ref: '#/components/schemas/ApiAtlasClusterAdvancedConfigurationView' autoScaling: $ref: '#/components/schemas/ClusterAutoScalingSettings' backupEnabled: description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. type: boolean biConnector: $ref: '#/components/schemas/BiConnector' clusterType: description: Configuration of nodes that comprise the cluster. enum: - REPLICASET - SHARDED - GEOSHARDED type: string configServerManagementMode: default: ATLAS_MANAGED description: Config Server Management Mode for creating or updating a sharded cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as `FIXED_TO_DEDICATED`, the cluster will always use a dedicated config server. enum: - ATLAS_MANAGED - FIXED_TO_DEDICATED externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers type: string configServerType: description: Describes a sharded cluster's config server type. enum: - DEDICATED - EMBEDDED externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers readOnly: true type: string connectionStrings: $ref: '#/components/schemas/ClusterConnectionStrings' createDate: description: Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string deleteAfterCreationHours: description: 'Number of hours after cluster creation that this cluster will be automatically deleted. This field is used to derive `deleteAfterDate` relative to `createDate`. When set to null or zero on cluster creation, the cluster will not be automatically deleted. When set to a positive value on cluster creation, the cluster will be automatically deleted after the specified number of hours. When updating this field on an existing (non-deleted) cluster, and this is set to null, then existing values are preserved for this & `deleteAfterDate`. When updating this field on an existing (non-deleted) cluster, and this is set to zero, then `deleteAfterDate` is reset to null (disable auto deletion) regardless of previous configurations. When updating this field on an existing (non-deleted) cluster, and this is set to a positive value, then `createDate` + `deleteAfterCreationHours` must be later than now else the field update is ignored and existing values are preserved for this & `deleteAfterDate`.' format: int32 type: integer deleteAfterDate: description: 'The date at which this cluster will be automatically deleted. This parameter expresses its value in the ISO 8601 timestamp format in UTC and is derived based on the `createDate` + `deleteAfterCreationHours`.' format: date-time readOnly: true type: string diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." format: double maximum: 4096 minimum: 10 type: number diskWarmingMode: default: FULLY_WARMED description: Disk warming mode selection. enum: - FULLY_WARMED - VISIBLE_EARLIER externalDocs: description: Reduce Secondary Disk Warming Impact url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact type: string encryptionAtRestProvider: description: 'Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize` setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.' enum: - NONE - AWS - AZURE - GCP externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ type: string featureCompatibilityVersion: description: Feature compatibility version of the cluster. readOnly: true type: string featureCompatibilityVersionExpirationDate: description: Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string globalClusterSelfManagedSharding: description: 'Set this field to configure the Sharding Management Mode when creating a new Global Cluster. When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience. When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience. This setting cannot be changed once the cluster is deployed.' externalDocs: description: Creating a Global Cluster url: https://dochub.mongodb.org/core/global-cluster-management type: boolean groupId: description: Unique 24-hexadecimal character string that identifies the project. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the cluster. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string labels: deprecated: true description: 'Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn''t display your labels. Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.' externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas items: $ref: '#/components/schemas/ComponentLabel' type: array 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array mongoDBEmployeeAccessGrant: $ref: '#/components/schemas/EmployeeAccessGrantView' mongoDBMajorVersion: description: "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version." example: '5.0' externalDocs: description: Available MongoDB Versions in Atlas url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use- type: string mongoDBVersion: description: Version of MongoDB that the cluster runs. example: 5.0.25 pattern: ([\d]+\.[\d]+\.[\d]+) type: string mongoURI: description: Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string mongoURIUpdated: description: Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string mongoURIWithOptions: description: Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string name: description: Human-readable label that identifies the cluster. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string numShards: default: 1 description: Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster. externalDocs: description: Sharding url: https://docs.mongodb.com/manual/sharding/ format: int32 maximum: 50 minimum: 1 type: integer paused: description: Flag that indicates whether the cluster is paused. type: boolean pitEnabled: description: Flag that indicates whether the cluster uses continuous cloud backups. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ type: boolean providerBackupEnabled: description: Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and `backupEnabled` are set to `false`, the cluster doesn't use MongoDB Cloud backups. type: boolean providerSettings: $ref: '#/components/schemas/ClusterProviderSettings' replicaSetScalingStrategy: default: WORKLOAD_TYPE description: 'Set this field to configure the replica set scaling mode for your cluster. By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.' enum: - SEQUENTIAL - WORKLOAD_TYPE - NODE_TYPE externalDocs: description: Modify the Replica Set Scaling Mode url: https://dochub.mongodb.org/core/scale-nodes type: string replicationFactor: default: 3 deprecated: true description: Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use `replicationSpecs` instead. enum: - 3 - 5 - 7 format: int32 type: integer replicationSpec: additionalProperties: $ref: '#/components/schemas/RegionSpec' description: Physical location where MongoDB Cloud provisions cluster nodes. title: Region Configuration type: object replicationSpecs: description: 'List of settings that configure your cluster regions. - For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes. - For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.' items: $ref: '#/components/schemas/LegacyReplicationSpec' type: array rootCertType: default: ISRGROOTX1 description: Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. enum: - ISRGROOTX1 type: string srvAddress: description: Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string stateName: description: "Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.\n\n - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.\n - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.\n - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.\n - `DELETING`: The cluster is in the process of deletion and will soon be deleted.\n - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal." enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING readOnly: true type: string tags: description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas items: $ref: '#/components/schemas/ResourceTag' type: array terminationProtectionEnabled: default: false description: Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. type: boolean versionReleaseSystem: default: LTS description: Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`. enum: - LTS - CONTINUOUS type: string title: Cluster Description type: object BaseCloudProviderInstanceSize: description: Instance size boundary to which your cluster can automatically scale. oneOf: - enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME title: AWS Instance Sizes type: string - enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME title: Azure Instance Sizes type: string - enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 title: GCP Instance Sizes type: string readOnly: true type: object AdvancedAutoScalingSettings: description: Options that determine how this cluster handles resource scaling. properties: compute: $ref: '#/components/schemas/AdvancedComputeAutoScaling' diskGB: $ref: '#/components/schemas/DiskGBAutoScaling' title: Automatic Scaling Settings type: object CloudRegionConfig20240805: description: Cloud service provider on which MongoDB Cloud provisions the hosts. discriminator: mapping: AWS: '#/components/schemas/AWSRegionConfig20240805' AZURE: '#/components/schemas/AzureRegionConfig20240805' GCP: '#/components/schemas/GCPRegionConfig20240805' TENANT: '#/components/schemas/TenantRegionConfig20240805' propertyName: providerName oneOf: - $ref: '#/components/schemas/AWSRegionConfig20240805' - $ref: '#/components/schemas/AzureRegionConfig20240805' - $ref: '#/components/schemas/GCPRegionConfig20240805' - $ref: '#/components/schemas/TenantRegionConfig20240805' properties: electableSpecs: $ref: '#/components/schemas/HardwareSpec20240805' priority: description: 'Precedence is given to this region when a primary election occurs. If your `regionConfigs` has only `readOnlySpecs`, `analyticsSpecs`, or both, set this value to `0`. If you have multiple `regionConfigs` objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`. **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.' format: int32 maximum: 7 minimum: 0 type: integer providerName: description: Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`. enum: - AWS - AZURE - GCP - TENANT type: string regionName: description: Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. oneOf: - description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. enum: - US_GOV_WEST_1 - US_GOV_EAST_1 - US_EAST_1 - US_EAST_2 - US_WEST_1 - US_WEST_2 - CA_CENTRAL_1 - EU_NORTH_1 - EU_WEST_1 - EU_WEST_2 - EU_WEST_3 - EU_CENTRAL_1 - EU_CENTRAL_2 - AP_EAST_1 - AP_EAST_2 - AP_NORTHEAST_1 - AP_NORTHEAST_2 - AP_NORTHEAST_3 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 - AP_SOUTHEAST_3 - AP_SOUTHEAST_4 - AP_SOUTHEAST_5 - AP_SOUTHEAST_6 - AP_SOUTHEAST_7 - AP_SOUTH_1 - AP_SOUTH_2 - SA_EAST_1 - CN_NORTH_1 - CN_NORTHWEST_1 - ME_SOUTH_1 - ME_CENTRAL_1 - AF_SOUTH_1 - EU_SOUTH_1 - EU_SOUTH_2 - IL_CENTRAL_1 - CA_WEST_1 - MX_CENTRAL_1 - GLOBAL title: AWS Regions type: string - description: Microsoft Azure Regions. enum: - US_CENTRAL - US_EAST - US_EAST_2 - US_NORTH_CENTRAL - US_WEST - US_SOUTH_CENTRAL - EUROPE_NORTH - EUROPE_WEST - US_WEST_CENTRAL - US_WEST_2 - US_WEST_3 - CANADA_EAST - CANADA_CENTRAL - BRAZIL_SOUTH - BRAZIL_SOUTHEAST - AUSTRALIA_CENTRAL - AUSTRALIA_CENTRAL_2 - AUSTRALIA_EAST - AUSTRALIA_SOUTH_EAST - GERMANY_WEST_CENTRAL - GERMANY_NORTH - SWEDEN_CENTRAL - SWEDEN_SOUTH - SWITZERLAND_NORTH - SWITZERLAND_WEST - UK_SOUTH - UK_WEST - NORWAY_EAST - NORWAY_WEST - INDIA_CENTRAL - INDIA_SOUTH - INDIA_WEST - CHINA_EAST - CHINA_NORTH - ASIA_EAST - JAPAN_EAST - JAPAN_WEST - ASIA_SOUTH_EAST - KOREA_CENTRAL - KOREA_SOUTH - FRANCE_CENTRAL - FRANCE_SOUTH - SOUTH_AFRICA_NORTH - SOUTH_AFRICA_WEST - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL - POLAND_CENTRAL - ISRAEL_CENTRAL - ITALY_NORTH - SPAIN_CENTRAL - MEXICO_CENTRAL - NEW_ZEALAND_NORTH - US_GOV_VIRGINIA - US_GOV_ARIZONA - US_GOV_TEXAS title: Azure Regions type: string - description: Google Compute Regions. enum: - EASTERN_US - EASTERN_US_AW - US_EAST_4 - US_EAST_4_AW - US_EAST_5 - US_EAST_5_AW - US_WEST_2 - US_WEST_2_AW - US_WEST_3 - US_WEST_3_AW - US_WEST_4 - US_WEST_4_AW - US_SOUTH_1 - US_SOUTH_1_AW - CENTRAL_US - CENTRAL_US_AW - WESTERN_US - WESTERN_US_AW - NORTH_AMERICA_NORTHEAST_1 - NORTH_AMERICA_NORTHEAST_2 - NORTH_AMERICA_SOUTH_1 - SOUTH_AMERICA_EAST_1 - SOUTH_AMERICA_WEST_1 - WESTERN_EUROPE - EUROPE_NORTH_1 - EUROPE_WEST_2 - EUROPE_WEST_3 - EUROPE_WEST_4 - EUROPE_WEST_6 - EUROPE_WEST_8 - EUROPE_WEST_9 - EUROPE_WEST_10 - EUROPE_WEST_12 - EUROPE_SOUTHWEST_1 - EUROPE_CENTRAL_2 - MIDDLE_EAST_CENTRAL_1 - MIDDLE_EAST_CENTRAL_2 - MIDDLE_EAST_WEST_1 - AUSTRALIA_SOUTHEAST_1 - AUSTRALIA_SOUTHEAST_2 - AFRICA_SOUTH_1 - EASTERN_ASIA_PACIFIC - NORTHEASTERN_ASIA_PACIFIC - SOUTHEASTERN_ASIA_PACIFIC - ASIA_EAST_2 - ASIA_NORTHEAST_2 - ASIA_NORTHEAST_3 - ASIA_SOUTH_1 - ASIA_SOUTH_2 - ASIA_SOUTHEAST_2 title: GCP Regions type: string type: object title: Cloud Service Provider Settings type: object TenantRegionConfig20240805: allOf: - $ref: '#/components/schemas/CloudRegionConfig20240805' - properties: backingProviderName: description: "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when `providerName` is `TENANT` and `electableSpecs.instanceSize` is `M0`, `M2` or `M5`. \n\nPlease note that using an `instanceSize` of `M2` or `M5` will create a Flex cluster instead. Support for the `instanceSize` of `M2` or `M5` will be discontinued in January 2026. We recommend using the Create Flex Cluster API for such configurations moving forward." enum: - AWS - GCP - AZURE externalDocs: description: Create Flex Cluster API url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster type: string type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. title: Tenant Regional Replication Specifications type: object ApiAtlasClusterAdvancedConfigurationView: description: Group of settings that configures a subset of the advanced configuration details. properties: customOpensslCipherConfigTls12: description: The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`. externalDocs: description: This option corresponds to the `opensslCipherConfig` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherConfig items: enum: - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 type: string type: array customOpensslCipherConfigTls13: description: The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`. externalDocs: description: This option corresponds to the `opensslCipherSuiteConfig` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherSuiteConfig items: enum: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 type: string maxItems: 4 type: array minimumEnabledTlsProtocol: description: Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version. enum: - TLS1_0 - TLS1_1 - TLS1_2 - TLS1_3 externalDocs: description: This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option. url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols type: string tlsCipherConfigMode: description: The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3. enum: - CUSTOM - DEFAULT type: string type: object CloudCluster: description: Settings that describe the clusters in each project that the API key is authorized to view. properties: alertCount: description: Whole number that indicates the quantity of alerts open on the cluster. format: int32 readOnly: true type: integer authEnabled: description: Flag that indicates whether authentication is required to access the nodes in this cluster. readOnly: true type: boolean availability: description: Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated. enum: - available - dead - unavailable - warning readOnly: true type: string backupEnabled: description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. readOnly: true type: boolean clusterId: description: Unique 24-hexadecimal character string that identifies the cluster. Each `clusterId` is used only once across all MongoDB Cloud deployments. pattern: ^([a-f0-9]{24})$ readOnly: true type: string dataSizeBytes: description: Total size of the data stored on each node in the cluster. The resource expresses this value in bytes. format: int64 readOnly: true type: integer name: description: Human-readable label that identifies the cluster. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ readOnly: true type: string nodeCount: description: Whole number that indicates the quantity of nodes that comprise the cluster. format: int32 readOnly: true type: integer sslEnabled: description: Flag that indicates whether TLS authentication is required to access the nodes in this cluster. readOnly: true type: boolean type: description: Human-readable label that indicates the cluster type. enum: - REPLICA_SET - SHARDED_CLUSTER readOnly: true type: string versions: description: List that contains the versions of MongoDB that each node in the cluster runs. items: type: string readOnly: true type: array uniqueItems: true readOnly: true type: object ClusterProviderSettings: description: Group of cloud provider settings that configure the provisioned MongoDB hosts. discriminator: mapping: AWS: '#/components/schemas/AWSCloudProviderSettings' AZURE: '#/components/schemas/AzureCloudProviderSettings' FLEX: '#/components/schemas/ClusterFlexProviderSettings' GCP: '#/components/schemas/CloudGCPProviderSettings' TENANT: '#/components/schemas/ClusterFreeProviderSettings' propertyName: providerName oneOf: - $ref: '#/components/schemas/AWSCloudProviderSettings' - $ref: '#/components/schemas/AzureCloudProviderSettings' - $ref: '#/components/schemas/CloudGCPProviderSettings' - $ref: '#/components/schemas/ClusterFreeProviderSettings' - $ref: '#/components/schemas/ClusterFlexProviderSettings' properties: providerName: type: string required: - providerName title: Cloud Service Provider Settings for a Cluster type: object HardwareSpec20240805: description: Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region. oneOf: - $ref: '#/components/schemas/AWSHardwareSpec20240805' - $ref: '#/components/schemas/AzureHardwareSpec20240805' - $ref: '#/components/schemas/GCPHardwareSpec20240805' - $ref: '#/components/schemas/TenantHardwareSpec20240805' properties: diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage format: double type: number type: object CloudProviderAzureAutoScaling: description: Range of instance sizes to which your cluster can scale. properties: compute: $ref: '#/components/schemas/AzureComputeAutoScalingRules' type: object AzureRegionConfig20240805: allOf: - $ref: '#/components/schemas/CloudRegionConfig20240805' - properties: analyticsAutoScaling: $ref: '#/components/schemas/AdvancedAutoScalingSettings' analyticsSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' autoScaling: $ref: '#/components/schemas/AdvancedAutoScalingSettings' effectiveAnalyticsSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' effectiveElectableSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' effectiveReadOnlySpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' readOnlySpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. title: Azure Regional Replication Specifications type: object CloudProviderRegions: properties: instanceSizes: description: List of instances sizes that this cloud provider supports. items: $ref: '#/components/schemas/ClusterCloudProviderInstanceSize' readOnly: true type: array provider: description: Human-readable label that identifies the Cloud provider. enum: - AWS - GCP - AZURE type: string type: object GCPComputeAutoScaling: description: Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes. properties: maxInstanceSize: description: Maximum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 title: GCP Instance Sizes type: string minInstanceSize: description: Minimum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 title: GCP Instance Sizes type: string title: GCP type: object AzureComputeAutoScalingRules: description: Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes. properties: maxInstanceSize: description: Maximum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME title: Azure Instance Sizes type: string minInstanceSize: description: Minimum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME title: Azure Instance Sizes type: string title: Azure type: object ServerlessConnectionStringsPrivateEndpointItem: description: Details of a private endpoint deployed for this serverless instance. properties: endpointId: description: Unique string that the cloud provider uses to identify the private endpoint. readOnly: true type: string providerName: description: Cloud provider where the private endpoint is deployed. enum: - AWS - AZURE readOnly: true type: string region: description: Region where the private endpoint is deployed. readOnly: true type: string title: Serverless Instance Private Endpoint Connection Strings Endpoint type: object AWSRegionConfig20240805: allOf: - $ref: '#/components/schemas/CloudRegionConfig20240805' - properties: analyticsAutoScaling: $ref: '#/components/schemas/AdvancedAutoScalingSettings' analyticsSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' autoScaling: $ref: '#/components/schemas/AdvancedAutoScalingSettings' effectiveAnalyticsSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' effectiveElectableSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' effectiveReadOnlySpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' readOnlySpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. title: AWS Regional Replication Specifications type: object ClusterStatus: properties: changeStatus: description: State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in. enum: - PENDING - APPLIED 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array type: object DiskGBAutoScaling: description: Setting that enables disk auto-scaling. properties: enabled: description: Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling. type: boolean 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 AzureHardwareSpec20240805: properties: diskIOPS: description: 'Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: - set `replicationSpecs[n].regionConfigs[m].providerName` : `Azure`. - set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` : `M40` or greater not including `Mxx_NVME` tiers. The maximum input/output operations per second (IOPS) depend on the selected `.instanceSize` and `.diskSizeGB`. This parameter defaults to the cluster tier''s standard IOPS value. Changing this value impacts cluster cost.' externalDocs: description: Programmatic API Keys url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure format: int32 type: integer diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage format: double type: number instanceSize: description: Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME title: Azure Instance Sizes type: string nodeCount: description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 type: integer type: object OrgGroup: properties: clusters: description: Settings that describe the clusters in each project that the API key is authorized to view. items: $ref: '#/components/schemas/CloudCluster' readOnly: true type: array groupId: description: Unique 24-hexadecimal character string that identifies the project. readOnly: true type: string groupName: description: Human-readable label that identifies the project. pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$ type: string orgId: description: Unique 24-hexadecimal character string that identifies the organization that contains the project. readOnly: true type: string orgName: description: Human-readable label that identifies the organization that contains the project. pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$ type: string planType: description: Human-readable label that indicates the plan type. readOnly: true type: string tags: description: List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array. items: readOnly: true type: string readOnly: true type: array type: object RegionSpec: description: Physical location where MongoDB Cloud provisions cluster nodes. properties: analyticsNodes: description: Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use `replicationSpecs[n].{region}.analyticsNodes` instead. format: int32 type: integer electableNodes: description: Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use `replicationSpecs[n].{region}.electableNodes` instead. enum: - 0 - 3 - 5 - 7 format: int32 type: integer priority: description: Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`. format: int32 maximum: 7 minimum: 0 type: integer readOnlyNodes: description: Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use `replicationSpecs[n].{region}.readOnlyNodes` instead. format: int32 type: integer title: Region Configuration type: object BiConnector: description: Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. externalDocs: description: MongoDB Connector for Business Intelligence url: https://docs.mongodb.com/bi-connector/current/ properties: enabled: description: Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster. type: boolean readPreference: description: Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes. enum: - PRIMARY - SECONDARY - ANALYTICS externalDocs: description: Read preferences for BI Connector url: https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences type: string title: MongoDB Connector for Business Intelligence Settings type: object CloudProviderAWSAutoScaling: description: Range of instance sizes to which your cluster can scale. properties: compute: $ref: '#/components/schemas/AWSComputeAutoScaling' type: object ClusterServerlessBackupOptions: description: Group of settings that configure serverless backup. properties: serverlessContinuousBackupEnabled: default: true description: "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" type: boolean title: Serverless Backup Options type: object ReplicationSpec20240805: description: Details that explain how MongoDB Cloud replicates data on the specified MongoDB database. properties: id: description: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request. This corresponds to Shard ID displayed in the UI. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string regionConfigs: description: 'Hardware specifications for nodes set for a given region. Each `regionConfigs` object must be unique by region and cloud provider within the `replicationSpec`. Each `regionConfigs` object describes the region''s priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. Tenant clusters only require `electableSpecs`. Dedicated clusters can specify any of these specifications, but must have at least one `electableSpecs` object within a `replicationSpec`. **Example:** If you set `replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize` : `M30`, set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` : `M30` if you have electable nodes and `replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize` : `M30` if you have read-only nodes.' items: $ref: '#/components/schemas/CloudRegionConfig20240805' type: array zoneId: description: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string zoneName: description: 'Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if `clusterType` : `GEOSHARDED` but not `selfManagedSharding` : `true`.' type: string title: Replication Specifications type: object ServerlessInstanceDescription: description: Group of settings that configure a MongoDB serverless instance. properties: connectionStrings: $ref: '#/components/schemas/ServerlessInstanceDescriptionConnectionStrings' createDate: description: Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string groupId: description: Unique 24-hexadecimal character string that identifies the project. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the serverless instance. example: 32b6e34b3d91647abb20e7b8 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array mongoDBVersion: description: Version of MongoDB that the serverless instance runs. pattern: ([\d]+\.[\d]+\.[\d]+) readOnly: true type: string name: description: Human-readable label that identifies the serverless instance. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string providerSettings: $ref: '#/components/schemas/ServerlessProviderSettings' serverlessBackupOptions: $ref: '#/components/schemas/ClusterServerlessBackupOptions' stateName: description: "Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.\n\n - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.\n - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.\n - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.\n - `DELETING`: The cluster is in the process of deletion and will soon be deleted.\n - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal." enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING readOnly: true type: string tags: description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. items: $ref: '#/components/schemas/ResourceTag' type: array terminationProtectionEnabled: default: false description: Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. type: boolean required: - providerSettings title: Serverless Instance Description type: object AWSCloudProviderSettings: allOf: - $ref: '#/components/schemas/ClusterProviderSettings' - properties: autoScaling: $ref: '#/components/schemas/CloudProviderAWSAutoScaling' diskIOPS: description: Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform. format: int32 type: integer encryptEBSVolume: default: true deprecated: true description: Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled. type: boolean instanceSizeName: description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME title: AWS Instance Sizes type: string regionName: description: Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. enum: - US_GOV_WEST_1 - US_GOV_EAST_1 - US_EAST_1 - US_EAST_2 - US_WEST_1 - US_WEST_2 - CA_CENTRAL_1 - EU_NORTH_1 - EU_WEST_1 - EU_WEST_2 - EU_WEST_3 - EU_CENTRAL_1 - EU_CENTRAL_2 - AP_EAST_1 - AP_EAST_2 - AP_NORTHEAST_1 - AP_NORTHEAST_2 - AP_NORTHEAST_3 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 - AP_SOUTHEAST_3 - AP_SOUTHEAST_4 - AP_SOUTHEAST_5 - AP_SOUTHEAST_6 - AP_SOUTHEAST_7 - AP_SOUTH_1 - AP_SOUTH_2 - SA_EAST_1 - CN_NORTH_1 - CN_NORTHWEST_1 - ME_SOUTH_1 - ME_CENTRAL_1 - AF_SOUTH_1 - EU_SOUTH_1 - EU_SOUTH_2 - IL_CENTRAL_1 - CA_WEST_1 - MX_CENTRAL_1 - GLOBAL externalDocs: description: AWS url: https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws title: AWS Regions type: string volumeType: description: Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters. enum: - STANDARD - PROVISIONED type: string type: object type: object AWSComputeAutoScaling: description: Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes. properties: maxInstanceSize: description: Maximum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME title: AWS Instance Sizes type: string minInstanceSize: description: Minimum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME title: AWS Instance Sizes type: string title: AWS type: object ComponentLabel: description: Human-readable labels applied to this MongoDB Cloud component. properties: key: description: Key applied to tag and categorize this component. maxLength: 255 minLength: 1 type: string value: description: Value set to the Key applied to tag and categorize this component. maxLength: 255 minLength: 1 type: string title: Component Label type: object ClusterFreeProviderSettings: allOf: - $ref: '#/components/schemas/ClusterProviderSettings' - properties: autoScaling: $ref: '#/components/schemas/ClusterFreeAutoScaling' backingProviderName: description: "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when `providerSettings.providerName` is `TENANT` and `providerSetting.instanceSizeName` is `M0`, `M2` or `M5`. \n\nPlease note that using an `instanceSize` of M2 or M5 will create a Flex cluster instead. Support for the `instanceSize` of M2 or M5 will be discontinued in January 2026. We recommend using the Create Flex Cluster API for such configurations moving forward." enum: - AWS - GCP - AZURE externalDocs: description: Create Flex Cluster API url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster type: string effectiveInstanceSizeName: description: The true tenant instance size. This is present to support backwards compatibility for deprecated provider types and/or instance sizes. enum: - FLEX - M2 - M5 - M0 readOnly: true type: string instanceSizeName: description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set `providerSettings.providerName` to `TENANT` and specify the cloud service provider in `providerSettings.backingProviderName`. enum: - M0 - M2 - M5 title: Tenant Instance Sizes type: string regionName: description: Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see `replicationSpec.{region}`. type: string type: object type: object ServerlessInstanceDescriptionConnectionStrings: description: Collection of Uniform Resource Locators that point to the MongoDB database. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ properties: privateEndpoint: description: List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE. items: $ref: '#/components/schemas/ServerlessConnectionStringsPrivateEndpointList' readOnly: true type: array standardSrv: description: Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol. externalDocs: description: Connection String URI Format url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string readOnly: true title: Serverless Instance Connection Strings type: object ClusterDescriptionConnectionStringsPrivateEndpoint: description: Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint. externalDocs: description: Private Endpoint for Dedicated Cluster url: https://docs.atlas.mongodb.com/security-private-endpoint/ properties: connectionString: description: Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint. readOnly: true type: string endpoints: description: List that contains the private endpoints through which you connect to MongoDB Cloud when you use `connectionStrings.privateEndpoint[n].connectionString` or `connectionStrings.privateEndpoint[n].srvConnectionString`. items: $ref: '#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint' readOnly: true type: array srvConnectionString: description: Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use `connectionStrings.privateEndpoint[n].connectionString`. readOnly: true type: string srvShardOptimizedConnectionString: description: Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for `connectionStrings.privateEndpoint[n].srvConnectionString`. readOnly: true type: string type: description: MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters. enum: - MONGOD - MONGOS readOnly: true type: string title: Cluster Private Endpoint Connection String type: object ClusterDescription20240805: properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig` to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: Reconfiguring a Replica Set during a regional outage url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set format: date-time type: string advancedConfiguration: $ref: '#/components/schemas/ApiAtlasClusterAdvancedConfigurationView' backupEnabled: default: false description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups. externalDocs: description: Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ type: boolean biConnector: $ref: '#/components/schemas/BiConnector' clusterType: description: Configuration of nodes that comprise the cluster. enum: - REPLICASET - SHARDED - GEOSHARDED type: string configServerManagementMode: default: ATLAS_MANAGED description: Config Server Management Mode for creating or updating a sharded cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as `FIXED_TO_DEDICATED`, the cluster will always use a dedicated config server. enum: - ATLAS_MANAGED - FIXED_TO_DEDICATED externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers type: string configServerType: description: Describes a sharded cluster's config server type. enum: - DEDICATED - EMBEDDED externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers readOnly: true type: string connectionStrings: $ref: '#/components/schemas/ClusterConnectionStrings' createDate: description: Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC. format: date-time readOnly: true type: string diskWarmingMode: default: FULLY_WARMED description: Disk warming mode selection. enum: - FULLY_WARMED - VISIBLE_EARLIER externalDocs: description: Reduce Secondary Disk Warming Impact url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact type: string effectiveReplicationSpecs: description: List of settings that represent the actual cluster state. This is read-only and always returned in the response. It reflects the current cluster configuration, which may differ from `replicationSpecs` due to system-managed changes. items: $ref: '#/components/schemas/ReplicationSpec20240805' readOnly: true type: array encryptionAtRestProvider: description: 'Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize` setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.' enum: - NONE - AWS - AZURE - GCP externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ type: string featureCompatibilityVersion: description: Feature compatibility version of the cluster. This will always appear regardless of whether FCV is pinned. readOnly: true type: string featureCompatibilityVersionExpirationDate: description: Feature compatibility version expiration date. Will only appear if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string globalClusterSelfManagedSharding: description: 'Set this field to configure the Sharding Management Mode when creating a new Global Cluster. When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience. When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience. This setting cannot be changed once the cluster is deployed.' externalDocs: description: Creating a Global Cluster url: https://dochub.mongodb.org/core/global-cluster-management type: boolean groupId: description: Unique 24-hexadecimal character string that identifies the project. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the cluster. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string internalClusterRole: description: 'Internal classification of the cluster''s role. Possible values: `NONE` (regular user cluster), `SYSTEM_CLUSTER` (system cluster for backup), `INTERNAL_SHADOW_CLUSTER` (internal use shadow cluster for testing).' enum: - NONE - SYSTEM_CLUSTER - INTERNAL_SHADOW_CLUSTER readOnly: true type: string labels: deprecated: true description: 'Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn''t display your labels. Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.' externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas items: $ref: '#/components/schemas/ComponentLabel' type: array 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array mongoDBEmployeeAccessGrant: $ref: '#/components/schemas/EmployeeAccessGrantView' mongoDBMajorVersion: description: "MongoDB major version of the cluster. Set to the binary major version. \n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version." externalDocs: description: Available MongoDB Versions in Atlas url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use- type: string mongoDBVersion: description: Version of MongoDB that the cluster runs. pattern: ([\d]+\.[\d]+\.[\d]+) readOnly: true type: string name: description: Human-readable label that identifies the cluster. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string paused: description: Flag that indicates whether the cluster is paused. type: boolean pitEnabled: description: Flag that indicates whether the cluster uses continuous cloud backups. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ type: boolean redactClientLogData: description: 'Enable or disable log redaction. This setting configures the ``mongod`` or ``mongos`` to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. *Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.' externalDocs: description: Log Redaction url: https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction type: boolean replicaSetScalingStrategy: default: WORKLOAD_TYPE description: 'Set this field to configure the replica set scaling mode for your cluster. By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.' enum: - SEQUENTIAL - WORKLOAD_TYPE - NODE_TYPE externalDocs: description: Modify the Replica Set Scaling Mode url: https://dochub.mongodb.org/core/scale-nodes type: string replicationSpecs: description: List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. items: $ref: '#/components/schemas/ReplicationSpec20240805' type: array retainBackups: default: false description: Flag that indicates whether the cluster retains backups. type: boolean rootCertType: default: ISRGROOTX1 description: Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. enum: - ISRGROOTX1 type: string stateName: description: "Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.\n\n - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.\n - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.\n - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.\n - `DELETING`: The cluster is in the process of deletion and will soon be deleted.\n - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal." enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING readOnly: true type: string tags: description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas items: $ref: '#/components/schemas/ResourceTag' type: array terminationProtectionEnabled: default: false description: Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. type: boolean useAwsTimeBasedSnapshotCopyForFastInitialSync: default: false description: Flag that indicates whether AWS time-based snapshot copies will be used instead of slower standard snapshot copies during fast Atlas cross-region initial syncs. This flag is only relevant for clusters containing AWS nodes. type: boolean versionReleaseSystem: default: LTS description: Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`. enum: - LTS - CONTINUOUS type: string type: object LegacyAtlasTenantClusterUpgradeRequest: description: Request containing target state of tenant cluster to be upgraded. properties: acceptDataRisksAndForceReplicaSetReconfig: description: If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig` to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: Reconfiguring a Replica Set during a regional outage url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set format: date-time type: string advancedConfiguration: $ref: '#/components/schemas/ApiAtlasClusterAdvancedConfigurationView' autoScaling: $ref: '#/components/schemas/ClusterAutoScalingSettings' backupEnabled: description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. type: boolean biConnector: $ref: '#/components/schemas/BiConnector' clusterType: description: Configuration of nodes that comprise the cluster. enum: - REPLICASET - SHARDED - GEOSHARDED type: string configServerManagementMode: default: ATLAS_MANAGED description: Config Server Management Mode for creating or updating a sharded cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as `FIXED_TO_DEDICATED`, the cluster will always use a dedicated config server. enum: - ATLAS_MANAGED - FIXED_TO_DEDICATED externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers type: string configServerType: description: Describes a sharded cluster's config server type. enum: - DEDICATED - EMBEDDED externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers readOnly: true type: string connectionStrings: $ref: '#/components/schemas/ClusterConnectionStrings' createDate: description: Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string deleteAfterCreationHours: description: 'Number of hours after cluster creation that this cluster will be automatically deleted. This field is used to derive `deleteAfterDate` relative to `createDate`. When set to null or zero on cluster creation, the cluster will not be automatically deleted. When set to a positive value on cluster creation, the cluster will be automatically deleted after the specified number of hours. When updating this field on an existing (non-deleted) cluster, and this is set to null, then existing values are preserved for this & `deleteAfterDate`. When updating this field on an existing (non-deleted) cluster, and this is set to zero, then `deleteAfterDate` is reset to null (disable auto deletion) regardless of previous configurations. When updating this field on an existing (non-deleted) cluster, and this is set to a positive value, then `createDate` + `deleteAfterCreationHours` must be later than now else the field update is ignored and existing values are preserved for this & `deleteAfterDate`.' format: int32 type: integer deleteAfterDate: description: 'The date at which this cluster will be automatically deleted. This parameter expresses its value in the ISO 8601 timestamp format in UTC and is derived based on the `createDate` + `deleteAfterCreationHours`.' format: date-time readOnly: true type: string diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." format: double maximum: 4096 minimum: 10 type: number diskWarmingMode: default: FULLY_WARMED description: Disk warming mode selection. enum: - FULLY_WARMED - VISIBLE_EARLIER externalDocs: description: Reduce Secondary Disk Warming Impact url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact type: string encryptionAtRestProvider: description: 'Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize` setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.' enum: - NONE - AWS - AZURE - GCP externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ type: string featureCompatibilityVersion: description: Feature compatibility version of the cluster. readOnly: true type: string featureCompatibilityVersionExpirationDate: description: Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string globalClusterSelfManagedSharding: description: 'Set this field to configure the Sharding Management Mode when creating a new Global Cluster. When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience. When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience. This setting cannot be changed once the cluster is deployed.' externalDocs: description: Creating a Global Cluster url: https://dochub.mongodb.org/core/global-cluster-management type: boolean groupId: description: Unique 24-hexadecimal character string that identifies the project. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the cluster. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string labels: deprecated: true description: 'Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn''t display your labels. Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.' externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas items: $ref: '#/components/schemas/ComponentLabel' type: array 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array mongoDBEmployeeAccessGrant: $ref: '#/components/schemas/EmployeeAccessGrantView' mongoDBMajorVersion: description: "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version." example: '5.0' externalDocs: description: Available MongoDB Versions in Atlas url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use- type: string mongoDBVersion: description: Version of MongoDB that the cluster runs. example: 5.0.25 pattern: ([\d]+\.[\d]+\.[\d]+) type: string mongoURI: description: Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string mongoURIUpdated: description: Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string mongoURIWithOptions: description: Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string name: description: Human-readable label that identifies the cluster. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string numShards: default: 1 description: Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster. externalDocs: description: Sharding url: https://docs.mongodb.com/manual/sharding/ format: int32 maximum: 50 minimum: 1 type: integer paused: description: Flag that indicates whether the cluster is paused. type: boolean pitEnabled: description: Flag that indicates whether the cluster uses continuous cloud backups. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ type: boolean providerBackupEnabled: description: Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and `backupEnabled` are set to `false`, the cluster doesn't use MongoDB Cloud backups. type: boolean providerSettings: $ref: '#/components/schemas/ClusterProviderSettings' replicaSetScalingStrategy: default: WORKLOAD_TYPE description: 'Set this field to configure the replica set scaling mode for your cluster. By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.' enum: - SEQUENTIAL - WORKLOAD_TYPE - NODE_TYPE externalDocs: description: Modify the Replica Set Scaling Mode url: https://dochub.mongodb.org/core/scale-nodes type: string replicationFactor: default: 3 deprecated: true description: Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use `replicationSpecs` instead. enum: - 3 - 5 - 7 format: int32 type: integer replicationSpec: additionalProperties: $ref: '#/components/schemas/RegionSpec' description: Physical location where MongoDB Cloud provisions cluster nodes. title: Region Configuration type: object replicationSpecs: description: 'List of settings that configure your cluster regions. - For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes. - For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.' items: $ref: '#/components/schemas/LegacyReplicationSpec' type: array rootCertType: default: ISRGROOTX1 description: Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. enum: - ISRGROOTX1 type: string srvAddress: description: Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string stateName: description: "Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.\n\n - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.\n - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.\n - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.\n - `DELETING`: The cluster is in the process of deletion and will soon be deleted.\n - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal." enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING readOnly: true type: string tags: description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas items: $ref: '#/components/schemas/ResourceTag' type: array terminationProtectionEnabled: default: false description: Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. type: boolean versionReleaseSystem: default: LTS description: Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`. enum: - LTS - CONTINUOUS type: string required: - name title: Tenant Cluster Upgrade Request type: object ClusterFreeAutoScaling: description: Range of instance sizes to which your cluster can scale. properties: compute: $ref: '#/components/schemas/FreeComputeAutoScalingRules' type: object ApiError: properties: badRequestDetail: $ref: '#/components/schemas/BadRequestDetail' detail: description: Describes the specific conditions or reasons that cause each type of error. type: string error: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status format: int32 readOnly: true type: integer errorCode: description: Application error code returned with this error. readOnly: true type: string parameters: description: Parameters used to give more information about the error. items: type: object readOnly: true type: array reason: description: Application error message returned with this error. readOnly: true type: string required: - error - errorCode type: object ServerlessProviderSettings: description: Group of cloud provider settings that configure the provisioned MongoDB serverless instance. properties: backingProviderName: description: Cloud service provider on which MongoDB Cloud provisioned the serverless instance. enum: - AWS - AZURE - GCP type: string effectiveDiskSizeGBLimit: description: Storage capacity of instance data volumes expressed in gigabytes. This value is not configurable for Serverless or effectively Flex clusters. format: int32 readOnly: true type: integer effectiveInstanceSizeName: $ref: '#/components/schemas/BaseCloudProviderInstanceSize' effectiveProviderName: description: Cloud service provider on which MongoDB Cloud effectively provisioned the serverless instance. readOnly: true type: string providerName: default: SERVERLESS description: Human-readable label that identifies the cloud service provider. enum: - SERVERLESS type: string regionName: description: Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). type: string required: - backingProviderName - regionName title: Cloud Service Provider Settings for a Serverless Instance type: object AWSHardwareSpec20240805: description: Hardware specifications for nodes deployed in the region. properties: diskIOPS: description: "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `replicationSpecs[n].regionConfigs[m].providerName` to `AWS`.\n- set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` to `M30` or greater (not including `Mxx_NVME` tiers).\n\n- set `replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType` to `PROVISIONED`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected `.instanceSize` and `.diskSizeGB`.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." format: int32 type: integer diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage format: double type: number ebsVolumeType: default: STANDARD description: "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters." enum: - STANDARD - PROVISIONED type: string instanceSize: description: Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME title: AWS Instance Sizes type: string nodeCount: description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 type: integer title: AWS Cluster Hardware Settings type: object AzureCloudProviderSettings: allOf: - $ref: '#/components/schemas/ClusterProviderSettings' - properties: autoScaling: $ref: '#/components/schemas/CloudProviderAzureAutoScaling' diskTypeName: description: Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected `providerSettings.instanceSizeName` applies. enum: - P2 - P3 - P4 - P6 - P10 - P15 - P20 - P30 - P40 - P50 externalDocs: description: Disk type url: https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes type: string instanceSizeName: description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME title: Azure Instance Sizes type: string regionName: description: Microsoft Azure Regions. enum: - US_CENTRAL - US_EAST - US_EAST_2 - US_NORTH_CENTRAL - US_WEST - US_SOUTH_CENTRAL - EUROPE_NORTH - EUROPE_WEST - US_WEST_CENTRAL - US_WEST_2 - US_WEST_3 - CANADA_EAST - CANADA_CENTRAL - BRAZIL_SOUTH - BRAZIL_SOUTHEAST - AUSTRALIA_CENTRAL - AUSTRALIA_CENTRAL_2 - AUSTRALIA_EAST - AUSTRALIA_SOUTH_EAST - GERMANY_WEST_CENTRAL - GERMANY_NORTH - SWEDEN_CENTRAL - SWEDEN_SOUTH - SWITZERLAND_NORTH - SWITZERLAND_WEST - UK_SOUTH - UK_WEST - NORWAY_EAST - NORWAY_WEST - INDIA_CENTRAL - INDIA_SOUTH - INDIA_WEST - CHINA_EAST - CHINA_NORTH - ASIA_EAST - JAPAN_EAST - JAPAN_WEST - ASIA_SOUTH_EAST - KOREA_CENTRAL - KOREA_SOUTH - FRANCE_CENTRAL - FRANCE_SOUTH - SOUTH_AFRICA_NORTH - SOUTH_AFRICA_WEST - UAE_CENTRAL - UAE_NORTH - QATAR_CENTRAL - POLAND_CENTRAL - ISRAEL_CENTRAL - ITALY_NORTH - SPAIN_CENTRAL - MEXICO_CENTRAL - NEW_ZEALAND_NORTH - US_GOV_VIRGINIA - US_GOV_ARIZONA - US_GOV_TEXAS externalDocs: description: Azure url: https://docs.atlas.mongodb.com/reference/microsoft-azure/ title: Azure Regions type: string type: object type: object AvailableCloudProviderRegion: properties: default: description: Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to `US_EAST_1`, GCP defaults to `CENTRAL_US`, and AZURE defaults to `US_WEST_2`. readOnly: true type: boolean name: description: Human-readable label that identifies the supported region. readOnly: true type: string type: object FieldViolation: properties: description: description: A description of why the request element is bad. type: string field: description: A path that leads to a field in the request body. type: string required: - description - field type: object LegacyReplicationSpec: properties: id: description: 'Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster. - If you include existing zones in the request, you must specify this parameter. - If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.' example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string numShards: default: 1 description: "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and `clusterType` is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." format: int32 type: integer regionsConfig: additionalProperties: $ref: '#/components/schemas/RegionSpec' description: Physical location where MongoDB Cloud provisions cluster nodes. title: Region Configuration type: object zoneName: description: Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `clusterType` is `GEOSHARDED`. type: string type: object TenantHardwareSpec20240805: properties: diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage format: double type: number effectiveInstanceSize: description: The true tenant instance size. This is present to support backwards compatibility for deprecated provider types and/or instance sizes. enum: - FLEX - M2 - M5 - M0 readOnly: true type: string instanceSize: description: Hardware specification for the instances in this M0/M2/M5 tier cluster. enum: - M0 - M2 - M5 title: Tenant Instance Sizes type: string type: object ClusterFlexProviderSettings: allOf: - $ref: '#/components/schemas/ClusterProviderSettings' - properties: backingProviderName: description: Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when `providerSettings.providerName` is `FLEX` and `providerSetting.instanceSizeName` is `FLEX`. enum: - AWS - GCP - AZURE type: string instanceSizeName: description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set `providerSettings.providerName` to `FLEX` and specify the cloud service provider in `providerSettings.backingProviderName`. enum: - FLEX title: Flex Instance Sizes type: string regionName: description: Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). type: string type: object type: object ClusterComputeAutoScaling: description: Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes. properties: enabled: default: false description: 'Flag that indicates whether instance size reactive auto-scaling is enabled. - Set to `true` to enable instance size reactive auto-scaling. If enabled, you must specify a value for `providerSettings.autoScaling.compute.maxInstanceSize`. - Set to `false` to disable instance size reactive auto-scaling.' type: boolean scaleDownEnabled: default: false description: Flag that indicates whether the cluster tier can scale down via reactive auto-scaling. This is required if `autoScaling.compute.enabled` is `true`. If you enable this option, specify a value for `providerSettings.autoScaling.compute.minInstanceSize`. type: boolean 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`. example: 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`. example: self type: string type: object PaginatedOrgGroupView: properties: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/OrgGroup' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object ClusterAutoScalingSettings: description: Range of instance sizes to which your cluster can scale. externalDocs: description: Cluster Auto-Scaling url: https://docs.atlas.mongodb.com/cluster-autoscaling/ properties: compute: $ref: '#/components/schemas/ClusterComputeAutoScaling' diskGBEnabled: default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. type: boolean title: Automatic Cluster Scaling Settings type: object ClusterConnectionStrings: description: Collection of Uniform Resource Locators that point to the MongoDB database. externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ properties: awsPrivateLink: additionalProperties: description: Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names. externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true type: string description: Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names. externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true type: object awsPrivateLinkSrv: additionalProperties: description: Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present. externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true type: string description: Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present. externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true type: object private: description: Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS. externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true type: string privateEndpoint: description: List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes. items: $ref: '#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint' readOnly: true type: array privateSrv: description: Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/). externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true type: string standard: description: Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol. externalDocs: description: Connection String URI Format url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string standardSrv: description: Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. externalDocs: description: Connection String URI Format url: https://docs.mongodb.com/manual/reference/connection-string/ readOnly: true type: string readOnly: true title: Cluster Connection Strings type: object DedicatedHardwareSpec20240805: description: The current hardware specifications for read only nodes in the region. oneOf: - $ref: '#/components/schemas/AWSHardwareSpec20240805' - $ref: '#/components/schemas/AzureHardwareSpec20240805' - $ref: '#/components/schemas/GCPHardwareSpec20240805' properties: diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage format: double type: number nodeCount: description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 type: integer readOnly: true type: object CloudProviderGCPAutoScaling: description: Range of instance sizes to which your cluster can scale. properties: compute: $ref: '#/components/schemas/GCPComputeAutoScaling' type: object ServerlessConnectionStringsPrivateEndpointList: description: Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint. externalDocs: description: Private Endpoint for Serverless Instance url: https://docs.atlas.mongodb.com/security-serverless-private-endpoint/ properties: endpoints: description: List that contains the private endpoints through which you connect to MongoDB Cloud when you use `connectionStrings.privateEndpoint[n].srvConnectionString`. items: $ref: '#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem' readOnly: true type: array srvConnectionString: description: Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). readOnly: true type: string type: description: MongoDB process type to which your application connects. enum: - MONGOS readOnly: true type: string title: Serverless Instance Private Endpoint Connection String type: object GCPRegionConfig20240805: allOf: - $ref: '#/components/schemas/CloudRegionConfig20240805' - properties: analyticsAutoScaling: $ref: '#/components/schemas/AdvancedAutoScalingSettings' analyticsSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' autoScaling: $ref: '#/components/schemas/AdvancedAutoScalingSettings' effectiveAnalyticsSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' effectiveElectableSpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' effectiveReadOnlySpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' readOnlySpecs: $ref: '#/components/schemas/DedicatedHardwareSpec20240805' type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. title: GCP Regional Replication Specifications type: object BadRequestDetail: description: Bad request detail. properties: fields: description: Describes all violations in a client request. items: $ref: '#/components/schemas/FieldViolation' type: array readOnly: true type: object PinFCVView: properties: expirationDate: description: Expiration date of the fixed FCV. If not specified, the expiration date will default to 4 weeks from the date FCV was originally pinned. Note that this field cannot exceed 4 weeks from the pinned date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array type: object CloudGCPProviderSettings: allOf: - $ref: '#/components/schemas/ClusterProviderSettings' - properties: autoScaling: $ref: '#/components/schemas/CloudProviderGCPAutoScaling' instanceSizeName: description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 title: GCP Instance Sizes type: string regionName: description: Google Compute Regions. enum: - EASTERN_US - EASTERN_US_AW - US_EAST_4 - US_EAST_4_AW - US_EAST_5 - US_EAST_5_AW - US_WEST_2 - US_WEST_2_AW - US_WEST_3 - US_WEST_3_AW - US_WEST_4 - US_WEST_4_AW - US_SOUTH_1 - US_SOUTH_1_AW - CENTRAL_US - CENTRAL_US_AW - WESTERN_US - WESTERN_US_AW - NORTH_AMERICA_NORTHEAST_1 - NORTH_AMERICA_NORTHEAST_2 - NORTH_AMERICA_SOUTH_1 - SOUTH_AMERICA_EAST_1 - SOUTH_AMERICA_WEST_1 - WESTERN_EUROPE - EUROPE_NORTH_1 - EUROPE_WEST_2 - EUROPE_WEST_3 - EUROPE_WEST_4 - EUROPE_WEST_6 - EUROPE_WEST_8 - EUROPE_WEST_9 - EUROPE_WEST_10 - EUROPE_WEST_12 - EUROPE_SOUTHWEST_1 - EUROPE_CENTRAL_2 - MIDDLE_EAST_CENTRAL_1 - MIDDLE_EAST_CENTRAL_2 - MIDDLE_EAST_WEST_1 - AUSTRALIA_SOUTHEAST_1 - AUSTRALIA_SOUTHEAST_2 - AFRICA_SOUTH_1 - EASTERN_ASIA_PACIFIC - NORTHEASTERN_ASIA_PACIFIC - SOUTHEASTERN_ASIA_PACIFIC - ASIA_EAST_2 - ASIA_NORTHEAST_2 - ASIA_NORTHEAST_3 - ASIA_SOUTH_1 - ASIA_SOUTH_2 - ASIA_SOUTHEAST_2 externalDocs: description: GCP url: https://docs.atlas.mongodb.com/reference/google-gcp/ title: GCP Regions type: string type: object type: object ClusterDescriptionAutoScalingModeConfiguration: description: Contains the internal configuration of AutoScaling on sharded clusters. properties: autoScalingMode: description: Describes whether cluster nodes scale together across all shards or independently. enum: - INDEPENDENT_SHARD_SCALING - CLUSTER_WIDE_SCALING type: string title: Internal configuration of AutoScaling on sharded clusters type: object PaginatedClusterDescription20240805: properties: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/ClusterDescription20240805' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object ClusterDescriptionConnectionStringsPrivateEndpointEndpoint: description: Details of a private endpoint deployed for this cluster. properties: endpointId: description: Unique string that the cloud provider uses to identify the private endpoint. readOnly: true type: string providerName: description: Cloud provider in which MongoDB Cloud deploys the private endpoint. enum: - AWS - AZURE - GCP readOnly: true type: string region: description: Region where the private endpoint is deployed. readOnly: true type: string title: Cluster Private Endpoint Connection Strings Endpoint type: object FreeComputeAutoScalingRules: description: Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. properties: maxInstanceSize: description: Maximum instance size to which your cluster can automatically scale. enum: - M0 - M2 - M5 title: Tenant Instance Sizes type: string minInstanceSize: description: Minimum instance size to which your cluster can automatically scale. enum: - M0 - M2 - M5 title: Tenant Instance Sizes type: string title: Tenant type: object PaginatedApiAtlasProviderRegionsView: properties: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/CloudProviderRegions' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object AdvancedComputeAutoScaling: description: Options that determine how this cluster handles CPU scaling. properties: enabled: description: 'Flag that indicates whether instance size reactive auto-scaling is enabled. - Set to `true` to enable instance size reactive auto-scaling. If enabled, you must specify a value for `replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize`. - Set to `false` to disable instance size reactive auto-scaling.' type: boolean maxInstanceSize: $ref: '#/components/schemas/BaseCloudProviderInstanceSize' minInstanceSize: $ref: '#/components/schemas/BaseCloudProviderInstanceSize' scaleDownEnabled: description: Flag that indicates whether the instance size may scale down via reactive auto-scaling. MongoDB Cloud requires this parameter if `replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled` is `true`. If you enable this option, specify a value for `replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize`. type: boolean title: Automatic Compute Scaling Settings type: object SampleDatasetStatus: properties: _id: description: Unique 24-hexadecimal character string that identifies this sample dataset. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string clusterName: description: Human-readable label that identifies the cluster into which you loaded the sample dataset. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ readOnly: true type: string completeDate: description: Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string createDate: description: Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string errorMessage: description: Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED. readOnly: true type: string state: description: Status of the sample dataset load job. enum: - WORKING - FAILED - COMPLETED readOnly: true type: string type: object GCPHardwareSpec20240805: properties: diskSizeGB: description: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier." externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage format: double type: number instanceSize: description: Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 title: GCP Instance Sizes type: string nodeCount: description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 type: integer type: object ClusterDescriptionProcessArgs20240805: properties: changeStreamOptionsPreAndPostImagesExpireAfterSeconds: default: -1 description: The minimum pre- and post-image retention time in seconds. externalDocs: description: 'This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).' url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds format: int32 type: integer chunkMigrationConcurrency: description: Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster. externalDocs: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency format: int32 type: integer customOpensslCipherConfigTls12: description: The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`. externalDocs: description: This option corresponds to the `opensslCipherConfig` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherConfig items: enum: - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 type: string type: array customOpensslCipherConfigTls13: description: The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`. externalDocs: description: This option corresponds to the `opensslCipherSuiteConfig` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherSuiteConfig items: enum: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 - TLS_AES_128_CCM_SHA256 type: string maxItems: 4 type: array defaultMaxTimeMS: description: Default time limit in milliseconds for individual read operations to complete. externalDocs: description: This option corresponds to the `defaultMaxTimeMS` cluster parameter. url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ format: int32 type: integer defaultWriteConcern: description: Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver. externalDocs: description: This option corresponds to the the implicit default write concern. url: https://docs.mongodb.com/manual/reference/write-concern/ type: string javascriptEnabled: description: Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative. externalDocs: description: This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster. url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled type: boolean minimumEnabledTlsProtocol: description: Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version. enum: - TLS1_0 - TLS1_1 - TLS1_2 - TLS1_3 externalDocs: description: This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option. url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols type: string noTableScan: description: Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results. externalDocs: description: This option corresponds to the `notablescan` `mongod` configuration file option. url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan type: boolean oplogMinRetentionHours: description: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates. externalDocs: description: This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option. url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours format: double nullable: true type: number oplogSizeMB: description: Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates. externalDocs: description: This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option. url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB format: int32 nullable: true type: integer queryStatsLogVerbosity: description: May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized `$queryStats` output in MongoDB logs. `$queryStats` output does not contain literals or field values. Enabling this setting might impact the performance of your cluster. externalDocs: description: This option corresponds to the `queryStats` component for the `logComponentVerbosity` server parameter. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity format: int32 type: integer sampleRefreshIntervalBIConnector: default: 0 description: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. externalDocs: description: This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option. url: https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs format: int32 minimum: 0 type: integer sampleSizeBIConnector: description: Number of documents per database to sample when gathering schema information. externalDocs: description: This option corresponds to the `sampleSize` `mongosqld` option. url: https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize format: int32 minimum: 0 type: integer tlsCipherConfigMode: description: The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3. enum: - CUSTOM - DEFAULT type: string transactionLifetimeLimitSeconds: description: Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic clean-up process. externalDocs: description: This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option. url: https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds format: int64 minimum: 1 type: integer type: object EmployeeAccessGrantView: description: MongoDB employee granted access level and expiration for a cluster. properties: expirationTime: description: Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time type: string grantType: description: Level of access to grant to MongoDB Employees. enum: - CLUSTER_DATABASE_LOGS - CLUSTER_INFRASTRUCTURE - CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array required: - expirationTime - grantType type: object ClusterCloudProviderInstanceSize: properties: availableRegions: description: List of regions that this cloud provider supports for this instance size. items: $ref: '#/components/schemas/AvailableCloudProviderRegion' readOnly: true type: array name: description: Human-readable label that identifies the instance size or cluster tier. readOnly: true type: string type: object parameters: envelope: description: Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. in: query name: envelope schema: default: false type: boolean pretty: description: Flag that indicates whether the response body should be in the prettyprint format. in: query name: pretty schema: default: false externalDocs: description: Prettyprint url: https://en.wikipedia.org/wiki/Prettyprint type: boolean groupId: description: 'Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.' in: path name: groupId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string itemsPerPage: description: Number of items that the response returns per page. in: query name: itemsPerPage schema: default: 100 maximum: 500 minimum: 1 type: integer pageNum: description: Number of the page that displays the current set of the total objects that the response returns. in: query name: pageNum schema: default: 1 minimum: 1 type: integer includeCount: description: Flag that indicates whether the response returns the total number of items (`totalCount`) in the response. in: query name: includeCount schema: default: true type: boolean responses: unauthorized: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 401 errorCode: NOT_ORG_GROUP_CREATOR reason: Unauthorized schema: $ref: '#/components/schemas/ApiError' description: Unauthorized. conflict: content: application/json: example: detail: '(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554' error: 409 errorCode: CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK reason: Conflict schema: $ref: '#/components/schemas/ApiError' description: Conflict. notFound: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS error: 404 errorCode: RESOURCE_NOT_FOUND reason: Not Found schema: $ref: '#/components/schemas/ApiError' description: Not Found. paymentRequired: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 402 errorCode: NO_PAYMENT_INFORMATION_FOUND reason: Payment Required schema: $ref: '#/components/schemas/ApiError' description: Payment Required. forbidden: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 403 errorCode: CANNOT_CHANGE_GROUP_NAME reason: Forbidden schema: $ref: '#/components/schemas/ApiError' description: Forbidden. tooManyRequests: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 429 errorCode: RATE_LIMITED reason: Too Many Requests schema: $ref: '#/components/schemas/ApiError' description: Too Many Requests. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' Retry-After: $ref: '#/components/headers/HeaderRetryAfter' internalServerError: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 500 errorCode: UNEXPECTED_ERROR reason: Internal Server Error schema: $ref: '#/components/schemas/ApiError' description: Internal Server Error. badRequest: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) No provider AWS exists. error: 400 errorCode: VALIDATION_ERROR reason: Bad Request schema: $ref: '#/components/schemas/ApiError' description: Bad Request. headers: HeaderRetryAfter: description: The minimum time you should wait, in seconds, before retrying the API request. This header might be returned for 429 or 503 error responses. schema: type: integer HeaderRateLimitRemaining: description: The number of requests remaining in the current rate limit window before the limit is reached. schema: type: integer HeaderRateLimitLimit: description: The maximum number of requests that a user can make within a specific time window. schema: type: integer securitySchemes: DigestAuth: scheme: digest type: http ServiceAccounts: description: Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview). flows: clientCredentials: scopes: {} tokenUrl: https://cloud.mongodb.com/api/oauth/token type: oauth2 x-externalLinks: - label: Back to Atlas Docs url: https://www.mongodb.com/docs/atlas/ - label: API Changelog url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/ x-topics: - content: The MongoDB Atlas Administration API is rate limited. To learn more about rate limiting, see the [Atlas Documentation on Rate Limiting](http://dochub.mongodb.org/core/atlas-api-rate-limit) title: Rate Limiting