MongoDB Atlas Administration API

---
components:
  headers:
    HeaderRateLimitLimit:
      description: The maximum number of requests that a user can make within a specific
        time window.
      schema:
        type: integer
    HeaderRateLimitRemaining:
      description: The number of requests remaining in the current rate limit window
        before the limit is reached.
      schema:
        type: integer
    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
  parameters:
    collectionName:
      description: Human-readable label that identifies the collection.
      in: path
      name: collectionName
      required: true
      schema:
        example: mycoll
        type: string
    databaseName:
      description: Human-readable label that identifies the database.
      in: path
      name: databaseName
      required: true
      schema:
        example: mydb
        type: string
    end:
      description: Date and time when MongoDB Cloud stops reporting the metrics. This
        parameter expresses its value in the ISO 8601 timestamp format in UTC. Include
        this parameter when you do not set **period**.
      in: query
      name: end
      schema:
        format: date-time
        type: string
    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
    federationSettingsId:
      description: Unique 24-hexadecimal digit string that identifies your federation.
      in: path
      name: federationSettingsId
      required: true
      schema:
        example: 55fa922fb343282757d9554e
        pattern: "^([a-f0-9]{24})$"
        type: string
    granularity:
      description: Duration that specifies the interval at which Atlas reports the
        metrics. This parameter expresses its value in the ISO 8601 duration format
        in UTC.
      in: query
      name: granularity
      required: true
      schema:
        example: PT1M
        type: string
    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
    identityProviderId:
      description: Legacy 20-hexadecimal digit string that identifies the identity
        provider. This id can be found within the Federation Management Console >
        Identity Providers tab by clicking the info icon in the IdP ID row of a configured
        identity provider.
      in: path
      name: identityProviderId
      required: true
      schema:
        example: c2777a9eca931f29fc2f
        pattern: "^([a-f0-9]{20})$"
        type: string
    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
    indexName:
      description: Human-readable label that identifies the index.
      in: path
      name: indexName
      required: true
      schema:
        example: myindex
        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
    liveMigrationId:
      description: Unique 24-hexadecimal digit string that identifies the migration.
      in: path
      name: liveMigrationId
      required: true
      schema:
        example: 6296fb4c7c7aa997cf94e9a8
        pattern: "^([a-f0-9]{24})$"
        type: string
    orgId:
      description: Unique 24-hexadecimal digit string that identifies the organization
        that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations)
        endpoint to retrieve all organizations to which the authenticated user has
        access.
      in: path
      name: orgId
      required: true
      schema:
        example: 4888442a3354817a7320eb61
        pattern: "^([a-f0-9]{24})$"
        type: string
    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
    period:
      description: Duration over which Atlas reports the metrics. This parameter expresses
        its value in the ISO 8601 duration format in UTC. Include this parameter when
        you do not set **start** and **end**.
      in: query
      name: period
      schema:
        example: PT10H
        type: string
    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
    processId:
      description: Combination of hostname and IANA port that serves the MongoDB process.
        The host must be the hostname, fully qualified domain name (FQDN), or Internet
        Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process
        (mongod or mongos). The port must be the IANA port on which the MongoDB process
        listens for requests.
      in: path
      name: processId
      required: true
      schema:
        example: my.host.name.com:27017
        pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
        type: string
    sandboxConfigId:
      description: Unique 24-hexadecimal digit string that identifies the sandbox
        configuration.
      in: path
      name: sandboxConfigId
      required: true
      schema:
        example: 507f1f77bcf86cd799439011
        pattern: "^([a-f0-9]{24})$"
        type: string
    start:
      description: Date and time when MongoDB Cloud begins reporting the metrics.
        This parameter expresses its value in the ISO 8601 timestamp format in UTC.
        Include this parameter when you do not set **period**.
      in: query
      name: start
      schema:
        format: date-time
        type: string
  responses:
    accepted:
      description: Accepted.
    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.
    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.
    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.
    gone:
      content:
        application/json:
          example:
            detail: This happens when a resource is marked for sunset and the sunset
              date is in the past.
            error: 410
            errorCode: VERSION_GONE
            reason: Gone
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Gone.
    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.
    methodNotAllowed:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 405
            errorCode: ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED
            reason: Method Not Allowed
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Method Not Allowed.
    noBody:
      description: This endpoint does not return a response body.
    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.
    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"
    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.
  schemas:
    AWSAccountDetails:
      properties:
        awsAccountId:
          description: The AWS Account ID.
          type: string
        cidrBlock:
          description: The VPC CIDR Block.
          type: string
        cloudProvider:
          description: Cloud provider.
          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
        vpcId:
          description: The VPC ID.
          type: string
      type: object
    AWSCloudProviderContainer:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderContainer"
      - properties:
          atlasCidrBlock:
            description: |-
              IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

              These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and  `/21` ranges.

              To modify the CIDR block, the target project cannot have:

              - Any M10 or greater clusters
              - Any other VPC peering connections

               You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

               **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.
            pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
            type: string
          regionName:
            description: Geographic area that Amazon Web Services (AWS) defines to
              which MongoDB Cloud deployed this network peering container.
            enum:
            - 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
            - SA_EAST_1
            - AP_EAST_1
            - AP_EAST_2
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTH_1
            - AP_SOUTH_2
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_CENTRAL_1
            - ME_SOUTH_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            type: string
          vpcId:
            description: Unique string that identifies the MongoDB Cloud VPC on AWS.
            example: vpc-b555d3b0d9cb783b0
            pattern: "^vpc-[0-9a-f]{17}$"
            readOnly: true
            type: string
        type: object
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      required:
      - regionName
      title: AWS
      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
    AWSCreateDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/CreateDataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you wish to store your archived data.
            enum:
            - US_EAST_1
            - US_WEST_2
            - SA_EAST_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_CENTRAL_1
            - AP_SOUTH_1
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_NORTHEAST_2
            type: string
        type: object
      type: object
    AWSCustomDNSEnabledView:
      properties:
        enabled:
          description: |-
            Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).
            When `"enabled": true`, connect to your cluster using Private IP for Peering connection strings.
          externalDocs:
            description: 'To learn more, see FAQ: Connection String Options in the
              MongoDB Atlas documentation.'
            url: https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-
          type: boolean
      required:
      - enabled
      type: object
    AWSDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/DataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you store your archived data.
            enum:
            - US_EAST_1
            - US_WEST_2
            - SA_EAST_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_CENTRAL_1
            - AP_SOUTH_1
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_NORTHEAST_2
            readOnly: true
            type: string
        type: object
      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.

             You can set different IOPS values on different shards when provisioned IOPS are supported.

             Change this parameter if you:

            - set `replicationSpecs[n].regionConfigs[m].providerName` to `AWS`.
            - set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` to `M30` or greater (not including `Mxx_NVME` tiers).

            - set `replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType` to `PROVISIONED`.

            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.
            MongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.

            - Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.
            - 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
    AWSInterfaceEndpoint:
      description: Group of Private Endpoint settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        connectionStatus:
          description: State of the Amazon Web Service PrivateLink connection when
            MongoDB Cloud received this request.
          enum:
          - PENDING_ACCEPTANCE
          - PENDING
          - AVAILABLE
          - REJECTED
          - DELETING
          readOnly: true
          type: string
        deleteRequested:
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
          type: boolean
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        interfaceEndpointId:
          description: Unique 24-hexadecimal digit string that identifies the interface
            endpoint.
          readOnly: true
          type: string
      required:
      - cloudProvider
      title: AWS
      type: object
    AWSKMSConfiguration:
      description: Amazon Web Services (AWS) KMS configuration details and encryption
        at rest configuration set for the specified project.
      externalDocs:
        description: Amazon Web Services Key Management Service
        url: https://www.mongodb.com/docs/atlas/security-aws-kms/
      properties:
        accessKeyID:
          description: Unique alphanumeric string that identifies an Identity and
            Access Management (IAM) access key with permissions required to access
            your Amazon Web Services (AWS) Customer Master Key (CMK).
          example: '019dd98d94b4bb778e7552e4'
          maxLength: 128
          minLength: 16
          type: string
        customerMasterKeyID:
          description: Unique alphanumeric string that identifies the Amazon Web Services
            (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB
            master keys.
          maxLength: 2048
          minLength: 1
          type: string
        enabled:
          description: Flag that indicates whether someone enabled encryption at rest
            for the specified project through Amazon Web Services (AWS) Key Management
            Service (KMS). To disable encryption at rest using customer key management
            and remove the configuration details, pass only this parameter with a
            value of `false`.
          type: boolean
        region:
          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
          ti

# --- truncated at 32 KB (3704 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/openapi/mongodb-atlas-openapi.yaml