api.yaml

openapi: 3.0.1
info:
  description: |-
    The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.

    The Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:

    ```
    curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
      --digest \
      --header "Accept: application/vnd.atlas.2023-11-15+json" \
      -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
    ```

    To 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).
  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 API
  version: "2.0"
  x-xgen-sha: 39851a1668ca4c597a5160513a31c3492ae7c425
servers:
- url: https://cloud.mongodb.com
tags:
- description: "Returns access logs for authentication attempts made to Atlas database\
    \ deployments. To view database access history, you must have either the Project\
    \ Owner or Organization Owner role."
  name: Access Tracking
- description: Returns and edits the conditions that trigger alerts and how MongoDB
    Cloud notifies users. This collection remains under revision and may change.
  name: Alert Configurations
- description: Returns and acknowledges alerts that MongoDB Cloud triggers based on
    the alert conditions that you define. This collection remains under revision and
    may change.
  name: Alerts
- description: "Returns, adds, edits, and removes Atlas Search indexes for the specified\
    \ cluster. Also returns and updates user-defined analyzers for the specified cluster."
  name: Atlas Search
- description: Returns and edits database auditing settings for MongoDB Cloud projects.
  name: Auditing
- description: "Returns and edits custom DNS configurations for MongoDB Cloud database\
    \ deployments on AWS. The resource requires your Project ID. If you use the VPC\
    \ peering on AWS and you use your own DNS servers instead of Amazon Route 53,\
    \ enable custom DNS. Before 31 March 2020, applications deployed within AWS using\
    \ custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over\
    \ private IP addresses. Custom DNS resolved to public IP addresses. AWS internal\
    \ DNS resolved to private IP addresses. Applications deployed with custom DNS\
    \ services in AWS should use Private IP for Peering connection strings."
  name: AWS Clusters DNS
- description: "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs,\
    \ and schedules. This resource applies only to clusters that use Cloud Backups."
  name: Cloud Backups
- description: "Manages the Cloud Migration Service. Source organizations, projects,\
    \ and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations,\
    \ projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't\
    \ use any authentication except SCRAM-SHA."
  name: Cloud Migration Service
- description: "Returns, adds, authorizes, and removes AWS IAM roles in Atlas."
  name: Cloud Provider Access
- description: "Returns, starts, or ends a cluster outage simulation."
  name: Cluster Outage Simulation
- description: "Returns, adds, edits, and removes database deployments. Changes to\
    \ cluster configurations can affect costs. This resource requires your Project\
    \ ID."
  name: Clusters
- description: "Returns, adds, and edits pinned namespaces for the specified cluster\
    \ or process. Also returns collection level latency metric data."
  name: Collection Level Metrics
- description: "Returns, adds, edits, and removes custom database user privilege roles.\
    \ Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in\
    \ roles can't describe. You define custom roles at the project level, for all\
    \ clusters in the project. This resource supports a subset of MongoDB privilege\
    \ actions. You can create a subset of custom role actions. To create a wider list\
    \ of custom role actions, use the MongoDB Cloud user interface. Custom roles must\
    \ include actions that all project's clusters support, and that are compatible\
    \ with each MongoDB version that your project's clusters use. For example, if\
    \ your project has MongoDB 4.2 clusters, you can't create custom roles that use\
    \ actions introduced in MongoDB 4.4."
  name: Custom Database Roles
- description: "Returns, adds, edits, and removes Federated Database Instances. This\
    \ resource requires your project ID. Changes to federated database instance configurations\
    \ can affect costs."
  name: Data Federation
- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\
    \ runs."
  name: Data Lake Pipelines
- description: "Returns, adds, edits, and removes database users."
  name: Database Users
- description: Returns and edits the Encryption at Rest using Customer Key Management
    configuration. MongoDB Cloud encrypts all storage whether or not you use your
    own key management.
  name: Encryption at Rest using Customer Key Management
- description: Returns events. This collection remains under revision and may change.
  name: Events
- description: "Returns, adds, edits, and removes federation-related features such\
    \ as role mappings and connected organization configurations."
  name: Federated Authentication
- description: |-
    Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.
    MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.
  name: Global Clusters
- description: Returns invoices.
  name: Invoices
- description: "Returns, edits, verifies, and removes LDAP configurations. An LDAP\
    \ configuration defines settings for MongoDB Cloud to connect to your LDAP server\
    \ over TLS for user authentication and authorization. Your LDAP server must be\
    \ visible to the internet or connected to your MongoDB Cloud cluster with VPC\
    \ Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud\
    \ admin user privilege to use these endpoints. Also, to configure user authentication\
    \ and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups\
    \ for which you have configured LDAPS can't create a cluster using a version of\
    \ MongoDB 3.6 or lower."
  name: LDAP Configuration
- description: "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints."
  name: Legacy Backup
- description: "Returns, edits, and removes maintenance windows. The maintenance procedure\
    \ that MongoDB Cloud performs requires at least one replica set election during\
    \ the maintenance window per replica set. You can defer a scheduled maintenance\
    \ event for a project up to two times. Deferred maintenance events occur during\
    \ your preferred maintenance window exactly one week after the previously scheduled\
    \ date and time."
  name: Maintenance Windows
- description: "Returns, adds, and edits MongoDB Cloud users."
  name: MongoDB Cloud Users
- description: Returns database deployment monitoring and logging data.
  name: Monitoring and Logs
- description: |-
    Returns, adds, edits, and removes network peering containers and peering connections.
    When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.
  name: Network Peering
- description: "Returns, adds, edits, or removes an online archive."
  name: Online Archive
- description: "Returns, adds, and edits organizational units in MongoDB Cloud."
  name: Organizations
- description: "Returns suggested indexes and slow query data for a database deployment.\
    \ Also enables or disables MongoDB Cloud-managed slow operation thresholds. To\
    \ view field values in a sample query, you must have the Project Data Access Read\
    \ Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than\
    \ the field values."
  name: Performance Advisor
- description: "Returns, adds, edits, and removes private endpoint services."
  name: Private Endpoint Services
- description: "Returns, adds, edits, and removes access tokens to use the MongoDB\
    \ Cloud API. MongoDB Cloud applies these keys to organizations. These resources\
    \ can return, assign, or revoke use of these keys within a specified project."
  name: Programmatic API Keys
- description: "Returns, adds, edits, and removes network access limits to database\
    \ deployments in Atlas. This resource replaces the whitelist resource. Atlas removed\
    \ whitelists in July 2021. Update your applications to use this new resource.\
    \ This resource manages a project's IP Access List and supports creating temporary\
    \ Access List entries that automatically expire within a user-configurable 7-day\
    \ period."
  name: Project IP Access List
- description: "Returns, adds, and edits collections of clusters and users in MongoDB\
    \ Cloud."
  name: Projects
- description: "You can continually push logs from mongod, mongos, and audit logs\
    \ to an AWS S3 bucket. Atlas exports logs every 5 minutes."
  name: Push-Based Log Export
- description: Creates one index to a database deployment in a rolling manner. You
    can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.
  name: Rolling Index
- description: Returns details that describe the MongoDB Cloud build and the access
    token that requests this resource. This starts the MongoDB Cloud API.
  name: Root
- description: "Returns, adds, edits, and removes serverless instances."
  name: Serverless Instances
- description: "Returns, adds, edits, and removes private endpoints for serverless\
    \ instances. To learn more, see the Atlas Administration API tab on the following\
    \ tutorial."
  externalDocs:
    description: Set Up a Private Endpoint for a Serverless Instance Tutorial
    url: https://dochub.mongodb.org/core/serverless-private-endpoint
  name: Serverless Private Endpoints
- description: Returns and adds restore jobs for shared-tier database deployments.
  name: Shared-Tier Restore Jobs
- description: Returns and requests to download shared-tier database deployment snapshots.
  name: Shared-Tier Snapshots
- description: "Returns, adds, edits, and removes Streams Instances. This resource\
    \ requires your project ID."
  name: Streams
- description: "Returns, adds, edits, or removes teams."
  name: Teams
- description: |-
    Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.

    **IMPORTANT**: Each project can only have one configuration per integrationType.
  name: Third-Party Integrations
- description: "Returns, edits, and removes user-managed X.509 configurations. Also\
    \ returns and generates MongoDB Cloud-managed X.509 certificates for database\
    \ users. The following resources help manage database users who authenticate using\
    \ X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud\
    \ do it for you. If MongoDB Cloud manages your certificates, it also manages your\
    \ Certificate Authority and can generate certificates for your database users.\
    \ No additional X.509 configuration is required. If you manage your certificates,\
    \ you must provide a Certificate Authority and generate certificates for your\
    \ database users."
  externalDocs:
    description: Self-Managed X.509 Certificates
    url: https://www.mongodb.com/docs/atlas/security-self-managed-x509/
  name: X.509 Authentication
paths:
  /api/atlas/v2:
    get:
      description: This resource returns information about the MongoDB application
        along with API key meta data.
      operationId: getSystemStatus
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/SystemStatus'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          description: Unauthorized.
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return the status of this MongoDB application
      tags:
      - Root
  /api/atlas/v2/alertConfigs/matchers/fieldNames:
    get:
      description: Get all field names that the `matchers.fieldName` parameter accepts
        when you create or update an Alert Configuration. You can successfully call
        this endpoint with any assigned role.
      operationId: listAlertConfigurationMatchersFieldNames
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MatcherFieldView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Get All Alert Configuration Matchers Field Names
      tags:
      - Alert Configurations
  /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 API Key can have any cluster-level role."
      operationId: listClustersForAllProjects
      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
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Authorized Clusters in All Projects
      tags:
      - Clusters
  /api/atlas/v2/federationSettings/{federationSettingsId}:
    delete:
      description: "Deletes the federation settings instance and all associated data,\
        \ including identity providers and domains. To use this resource, the requesting\
        \ API Key must have the Organization Owner role in the last remaining connected\
        \ organization. **Note**: requests to this resource will fail if there is\
        \ more than one connected organization in the federation."
      operationId: deleteFederationApp
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: No Content
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete the federation settings instance.
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs:
    get:
      description: "Returns all connected org configs in the specified federation.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Owner role in one of the connected orgs."
      operationId: listConnectedOrgConfigs
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConnectedOrgConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Connected Org Configs from the Federation
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}:
    delete:
      description: "Removes one connected organization configuration from the specified\
        \ federation. To use this resource, the requesting API Key must have the Organization\
        \ Owner role. Note: This request fails if only one connected organization\
        \ exists in the federation."
      operationId: removeConnectedOrgConfig
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 24-hexadecimal digit string that identifies the connected
          organization configuration to remove.
        in: path
        name: orgId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Org Config Connected to One Federation
      tags:
      - Federated Authentication
    get:
      description: "Returns the specified connected org config from the specified\
        \ federation. To use this resource, the requesting API Key must have the Organization\
        \ Owner role in the connected org."
      operationId: getConnectedOrgConfig
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 24-hexadecimal digit string that identifies the connected
          organization configuration to return.
        in: path
        name: orgId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ConnectedOrgConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Org Config Connected to One Federation
      tags:
      - Federated Authentication
    patch:
      description: "Updates one connected organization configuration from the specified\
        \ federation. To use this resource, the requesting API Key must have the Organization\
        \ Owner role. \n\n**Note** If the organization configuration has no associated\
        \ identity provider, you can't use this resource to update role mappings or\
        \ post authorization role grants.  \n\n**Note**: The domainRestrictionEnabled\
        \ field defaults to false if not provided in the request. \n\n**Note**: If\
        \ the identityProviderId field is not provided, you will disconnect the organization\
        \ and the identity provider. \n\n**Note**: Currently connected data access\
        \ identity providers missing from the dataAccessIdentityProviderIds field\
        \ will be disconnected."
      operationId: updateConnectedOrgConfig
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 24-hexadecimal digit string that identifies the connected
          organization configuration to update.
        in: path
        name: orgId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ConnectedOrgConfig'
        description: The connected organization configuration that you want to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ConnectedOrgConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Org Config Connected to One Federation
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings:
    get:
      description: "Returns all role mappings from the specified organization in the\
        \ specified federation. To use this resource, the requesting API Key must\
        \ have the Organization Owner role."
      operationId: listRoleMappings
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleMappingView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Role Mappings from One Organization
      tags:
      - Federated Authentication
    post:
      description: "Adds one role mapping to the specified organization in the specified\
        \ federation. To use this resource, the requesting API Key must have the Organization\
        \ Owner role."
      operationId: createRoleMapping
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/AuthFederationRoleMapping'
        description: The role mapping that you want to create.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AuthFederationRoleMapping'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Add One Role Mapping to One Organization
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}:
    delete:
      description: "Removes one role mapping in the specified organization from the\
        \ specified federation. To use this resource, the requesting API Key must\
        \ have the Organization Owner role."
      operationId: deleteRoleMapping
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: Unique 24-hexadecimal digit string that identifies the role mapping
          that you want to remove.
        in: path
        name: id
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: No Content
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Role Mapping from One Organization
      tags:
      - Federated Authentication
    get:
      description: "Returns one role mapping from the specified organization in the\
        \ specified federation. To use this resource, the requesting API Key must\
        \ have the Organization Owner role."
      operationId: getRoleMapping
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: Unique 24-hexadecimal digit string that identifies the role mapping
          that you want to return.
        in: path
        name: id
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AuthFederationRoleMapping'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Role Mapping from One Organization
      tags:
      - Federated Authentication
    put:
      description: "Updates one role mapping in the specified organization in the\
        \ specified federation. To use this resource, the requesting API Key must\
        \ have the Organization Owner role."
      operationId: updateRoleMapping
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: Unique 24-hexadecimal digit string that identifies the role mapping
          that you want to update.
        in: path
        name: id
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/AuthFederationRoleMapping'
        description: The role mapping that you want to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AuthFederationRoleMapping'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Role Mapping in One Organization
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders:
    get:
      description: "Returns all identity providers with the provided protocol and\
        \ type in the specified federation. If no protocol is specified, only SAML\
        \ identity providers will be returned. If no idpType is specified, only WORKFORCE\
        \ identity providers will be returned. To use this resource, the requesting\
        \ API Key must have the Organization Owner role in one of the connected organizations."
      operationId: listIdentityProviders
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      - description: The protocols of the target identity providers.
        in: query
        name: protocol
        schema:
          type: array
          items:
            type: string
            default: SAML
            enum:
            - SAML
            - OIDC
      - description: The types of the target identity providers.
        in: query
        name: idpType
        schema:
          type: array
          items:
            type: string
            default: WORKFORCE
            enum:
            - WORKFORCE
            - WORKLOAD
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedFederationIdentityProvider'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return all identity providers from the specified federation.
      tags:
      - Federated Authentication
    post:
      description: |-
        Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.

        **Note**: This resource only supports the creation of OIDC identity providers.
      operationId: createIdentityProvider
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-11-15+json:
            schema:
              $ref: '#/components/schemas/FederationOidcIdentityProviderUpdate'
        description: The identity provider that you want to create.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/FederationOidcIdentityProvider'
              x-xgen-version: 2023-11-15
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create one identity provider
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}:
    delete:
      description: "Deletes one identity provider in the specified federation. To\
        \ use this resource, the requesting API Key must have the Organization Owner\
        \ role in one of the connected organizations. \n\n**Note**: Requests to this\
        \ resource will fail if the identity provider has any connected organizations.\
        \ Before deleting an identity provider, disconnect all organizations and confirm\
        \ that no organization in your account uses this identity provider. To learn\
        \ more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/)."
      operationId: deleteIdentityProvider
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: Unique 24-hexadecimal digit string that identifies the identity
          provider to connect.
        in: path
        name: identityProviderId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
      - $ref: '#/components/parameters/envelope'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-11-15+json:
              x-xgen-version: 2023-11-15
          description: No Response
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete the identity provider.
      tags:
      - Federated Authentication
    get:
      description: "Returns one identity provider in the specified federation by the\
        \ identity provider's id. To use this resource, the requesting API Key must\
        \ have the Organization Owner role in one of the connected organizations.\
        \ Deprecated versions: v2-{2023-01-01}"
      operationId: getIdentityProvider
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: "Unique string that identifies the identity provider to connect.\
          \ If using an API version before 11-15-2023, use the legacy 20-hexadecimal\
          \ digit id. 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. For all other versions, use the 24-hexadecimal\
          \ digit id."
        in: path
        name: identityProviderId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/FederationIdentityProvider'
              x-xgen-version: 2023-11-15
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return one identity provider from the specified federation by id.
      tags:
      - Federated Authentication
    patch:
      description: |-
        Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.

        **Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. Deprecated versions: v2-{2023-01-01}
      operationId: updateIdentityProvider
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: "Unique string that identifies the identity provider to connect.\
          \ If using an API version before 11-15-2023, use the legacy 20-hexadecimal\
          \ digit id. 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. For all other versions, use the 24-hexadecimal\
          \ digit id."
        in: path
        name: identityProviderId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-11-15+json:
            schema:
              $ref: '#/components/schemas/FederationIdentityProviderUpdate'
        description: The identity provider that you want to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/FederationIdentityProvider'
              x-xgen-version: 2023-11-15
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update the identity provider.
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks:
    delete:
      description: "Revokes the JWKS tokens from the requested OIDC identity provider.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Owner role in one of the connected organizations. \n\n**Note**: Revoking\
        \ your JWKS tokens immediately refreshes your IdP public keys from all your\
        \ Atlas clusters, invalidating previously signed access tokens and logging\
        \ out all users. You may need to restart your MongoDB clients. All organizations\
        \ connected to the identity provider will be affected. To learn more, see\
        \ [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks)."
      operationId: revokeJwksFromIdentityProvider
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - description: Unique 24-hexadecimal digit string that identifies the identity
          provider to connect.
        in: path
        name: identityProviderId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
      - $ref: '#/components/parameters/envelope'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-11-15+json:
              x-xgen-version: 2023-11-15
          description: No Response
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Revoke the JWKS tokens from an OIDC identity provider.
      tags:
      - Federated Authentication
  /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml:
    get:
      description: "Returns the metadata of one identity provider in the specified\
        \ federation. To use this resource, the requesting API Key must have the Organization\
        \ Owner role in one of the connected organizations."
      operationId: getIdentityProviderMetadata
      parameters:
      - $ref: '#/components/parameters/federationSettingsId'
      - $ref: '#/components/parameters/identityProviderId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: string
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return the metadata of one identity provider in the specified federation.
      tags:
      - Federated Authentication
  /api/atlas/v2/groups:
    get:
      description: "Returns details about all projects. Projects group clusters into\
        \ logical collections that support an application environment, workload, or\
        \ both. Each project can have its own users, teams, security, tags, and alert\
        \ settings. To use this resource, the requesting API Key must have the Read\
        \ Write role."
      operationId: listProjects
      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/PaginatedAtlasGroupView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Projects
      tags:
      - Projects
    post:
      description: "Creates one project. Projects group clusters into logical collections\
        \ that support an application environment, workload, or both. Each project\
        \ can have its own users, teams, security, tags, and alert settings. To use\
        \ this resource, the requesting API Key must have the Read Write role."
      operationId: createProject
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the MongoDB\
          \ Cloud user to whom to grant the Project Owner role on the specified project.\
          \ If you set this parameter, it overrides the default value of the oldest\
          \ Organization Owner."
        in: query
        name: projectOwnerId
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/Group'
        description: Creates one project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/Group'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Project
      tags:
      - Projects
  /api/atlas/v2/groups/byName/{groupName}:
    get:
      description: "Returns details about the specified project. Projects group clusters\
        \ into logical collections that support an application environment, workload,\
        \ or both. Each project can have its own users, teams, security, tags, and\
        \ alert settings. To use this resource, the requesting API Key must have the\
        \ Project Read Only role."
      operationId: getProjectByName
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies this project.
        in: path
        name: groupName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/Group'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Project using Its Name
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}:
    delete:
      description: "Removes the specified project. Projects group clusters into logical\
        \ collections that support an application environment, workload, or both.\
        \ Each project can have its own users, teams, security, tags, and alert settings.\
        \ You can delete a project only if there are no Online Archives for the clusters\
        \ in the project. To use this resource, the requesting API Key must have the\
        \ Project Owner role."
      operationId: deleteProject
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Project
      tags:
      - Projects
    get:
      description: "Returns details about the specified project. Projects group clusters\
        \ into logical collections that support an application environment, workload,\
        \ or both. Each project can have its own users, teams, security, tags, and\
        \ alert settings. To use this resource, the requesting API Key must have the\
        \ Project Read Only role."
      operationId: getProject
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/Group'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Project
      tags:
      - Projects
    patch:
      description: "Updates the human-readable label that identifies the specified\
        \ project, or the tags associated with the project. To use this resource,\
        \ the requesting API Key must have the Project Owner role."
      operationId: updateProject
      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/GroupUpdate'
        description: Project to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/Group'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Project
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/access:
    post:
      description: "Adds one MongoDB Cloud user to the specified project. If the MongoDB\
        \ Cloud user is not a member of the project's organization, then the user\
        \ must accept their invitation to the organization to access information within\
        \ the specified project. If the MongoDB Cloud User is already a member of\
        \ the project's organization, then they will be added to the project immediately\
        \ and an invitation will not be returned by this resource. To use this resource,\
        \ the requesting API Key must have the Group User Admin role."
      operationId: addUserToProject
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/GroupInvitationRequest'
        description: Adds one MongoDB Cloud user to the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationInvitation'
              x-xgen-version: 2023-02-01
          description: OK
        "204":
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: 2023-02-01
          description: No Content
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Add One MongoDB Cloud User to One Project
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/accessList:
    get:
      description: "Returns all access list entries from the specified project's IP\
        \ access list. Each entry in the project's IP access list contains either\
        \ one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud\
        \ only allows client connections to the cluster from entries in the project's\
        \ IP access list. To use this resource, the requesting API Key must have the\
        \ Project Read Only or Project Charts Admin roles. This resource replaces\
        \ the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update\
        \ your applications to use this new resource. The `/groups/{GROUP-ID}/accessList`\
        \ endpoint manages the database IP access list. This endpoint is distinct\
        \ from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which\
        \ manages the access list for MongoDB Cloud organizations."
      externalDocs:
        description: IP access list
        url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list
      operationId: listProjectIpAccessLists
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedNetworkAccessView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Project IP Access List
      tags:
      - Project IP Access List
    post:
      description: "Adds one or more access list entries to the specified project.\
        \ MongoDB Cloud only allows client connections to the cluster from entries\
        \ in the project's IP access list. Write each entry as either one IP address\
        \ or one CIDR-notated block of IP addresses. To use this resource, the requesting\
        \ API Key must have the Project Owner or Project Charts Admin roles. This\
        \ resource replaces the whitelist resource. MongoDB Cloud removed whitelists\
        \ in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList`\
        \ endpoint manages the database IP access list. This endpoint is distinct\
        \ from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which\
        \ manages the access list for MongoDB Cloud organizations. This endpoint doesn't\
        \ support concurrent `POST` requests. You must submit multiple `POST` requests\
        \ synchronously."
      externalDocs:
        description: IP access list
        url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list
      operationId: createProjectIpAccessList
      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'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/NetworkPermissionEntry'
        description: One or more access list entries to add to the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedNetworkAccessView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Add Entries to Project IP Access List
      tags:
      - Project IP Access List
  /api/atlas/v2/groups/{groupId}/accessList/{entryValue}:
    delete:
      description: "Removes one access list entry from the specified project's IP\
        \ access list. Each entry in the project's IP access list contains one IP\
        \ address, one CIDR-notated block of IP addresses, or one AWS Security Group\
        \ ID. MongoDB Cloud only allows client connections to the cluster from entries\
        \ in the project's IP access list. To use this resource, the requesting API\
        \ Key must have the Project Owner role. This resource replaces the whitelist\
        \ resource. MongoDB Cloud removed whitelists in July 2021. Update your applications\
        \ to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages\
        \ the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist`\
        \ endpoint, which manages the access list for MongoDB Cloud organizations."
      externalDocs:
        description: IP access list
        url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list
      operationId: deleteProjectIpAccessList
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: |-
          Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:

          - how your application established the connection,
          - how MongoDB Cloud or the driver using the address behaves, and
          - which protocol (like TCP or UDP) the connection uses.
        in: path
        name: entryValue
        required: true
        schema:
          type: string
          example: "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348\
            \ or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS\
            \ SG: sg-903004f8"
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\
            :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\\
            -[a-f0-9]{8})?$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Entry from One Project IP Access List
      tags:
      - Project IP Access List
    get:
      description: "Returns one access list entry from the specified project's IP\
        \ access list. Each entry in the project's IP access list contains either\
        \ one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud\
        \ only allows client connections to the cluster from entries in the project's\
        \ IP access list. To use this resource, the requesting API Key must have the\
        \ Project Read Only or Project Charts Admin roles. This resource replaces\
        \ the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update\
        \ your applications to use this new resource. This endpoint (`/groups/{GROUP-ID}/accessList`)\
        \ manages the Project IP Access List. It doesn't manage the access list for\
        \ MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (`/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist`)\
        \ manages those access lists."
      externalDocs:
        description: IP access list
        url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list
      operationId: getProjectIpList
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Access list entry that you want to return from the project's\
          \ IP access list. This value can use one of the following: one AWS security\
          \ group ID, one IP address, or one CIDR block of addresses. For CIDR blocks\
          \ that use a subnet mask, replace the forward slash (`/`) with its URL-encoded\
          \ value (`%2F`)."
        in: path
        name: entryValue
        required: true
        schema:
          type: string
          example: "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348\
            \ or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS\
            \ SG: sg-903004f8"
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\
            :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\\
            -[a-f0-9]{8})?$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NetworkPermissionEntry'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Project IP Access List Entry
      tags:
      - Project IP Access List
  /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status:
    get:
      description: Returns the status of one project IP access list entry. This resource
        checks if the provided project IP access list entry applies to all cloud providers
        serving clusters from the specified project.
      operationId: getProjectIpAccessListStatus
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Network address or cloud provider security construct that identifies
          which project access list entry to be verified.
        in: path
        name: entryValue
        required: true
        schema:
          type: string
          example: "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348\
            \ or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS\
            \ SG: sg-903004f8"
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\
            :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\\
            -[a-f0-9]{8})?$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NetworkPermissionEntryStatus'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Status of One Project IP Access List Entry
      tags:
      - Project IP Access List
  /api/atlas/v2/groups/{groupId}/alertConfigs:
    get:
      description: |-
        Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listAlertConfigurations
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAlertConfigView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Alert Configurations for One Project
      tags:
      - Alert Configurations
    post:
      description: |-
        Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.

        This resource remains under revision and may change.
      operationId: createAlertConfiguration
      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/GroupAlertsConfig'
        description: Creates one alert configuration for the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupAlertsConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Alert Configuration in One Project
      tags:
      - Alert Configurations
  /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}:
    delete:
      description: |-
        Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.

        This resource remains under revision and may change.
      operationId: deleteAlertConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the alert\
          \ configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations)\
          \ endpoint to retrieve all alert configurations to which the authenticated\
          \ user has access."
        in: path
        name: alertConfigId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: No Content
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Alert Configuration from One Project
      tags:
      - Alert Configurations
    get:
      description: |-
        Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: getAlertConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the alert\
          \ configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations)\
          \ endpoint to retrieve all alert configurations to which the authenticated\
          \ user has access."
        in: path
        name: alertConfigId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupAlertsConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Alert Configuration from One Project
      tags:
      - Alert Configurations
    patch:
      description: |-
        Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.

        **NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).

        This resource remains under revision and may change.
      operationId: toggleAlertConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the alert\
          \ configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations)\
          \ endpoint to retrieve all alert configurations to which the authenticated\
          \ user has access."
        in: path
        name: alertConfigId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/AlertsToggle'
        description: Enables or disables the specified alert configuration in the
          specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupAlertsConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Toggle One State of One Alert Configuration in One Project
      tags:
      - Alert Configurations
    put:
      description: |-
        Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.

        **NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).

        This resource remains under revision and may change.
      operationId: updateAlertConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the alert\
          \ configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations)\
          \ endpoint to retrieve all alert configurations to which the authenticated\
          \ user has access."
        in: path
        name: alertConfigId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/GroupAlertsConfig'
        description: Updates one alert configuration in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupAlertsConfig'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Alert Configuration for One Project
      tags:
      - Alert Configurations
  /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts:
    get:
      description: |-
        Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listAlertsByAlertConfigurationId
      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: "Unique 24-hexadecimal digit string that identifies the alert\
          \ configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations)\
          \ endpoint to retrieve all alert configurations to which the authenticated\
          \ user has access."
        in: path
        name: alertConfigId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAlertView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Open Alerts for Alert Configuration
      tags:
      - Alerts
  /api/atlas/v2/groups/{groupId}/alerts:
    get:
      description: |-
        Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listAlerts
      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: Status of the alerts to return. Omit to return all alerts in
          all statuses.
        in: query
        name: status
        schema:
          type: string
          enum:
          - OPEN
          - TRACKING
          - CLOSED
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAlertView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Alerts from One Project
      tags:
      - Alerts
  /api/atlas/v2/groups/{groupId}/alerts/{alertId}:
    get:
      description: |-
        Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: getAlert
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the alert.\
          \ Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve\
          \ all alerts to which the authenticated user has access."
        in: path
        name: alertId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AlertViewForNdsGroup'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Alert from One Project
      tags:
      - Alerts
    patch:
      description: |-
        Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.

        This resource remains under revision and may change.
      operationId: acknowledgeAlert
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the alert.\
          \ Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve\
          \ all alerts to which the authenticated user has access."
        in: path
        name: alertId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/AlertViewForNdsGroup'
        description: Confirm one alert.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AlertViewForNdsGroup'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Acknowledge One Alert from One Project
      tags:
      - Alerts
  /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs:
    get:
      description: |-
        Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listAlertConfigurationsByAlertId
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - description: "Unique 24-hexadecimal digit string that identifies the alert.\
          \ Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve\
          \ all alerts to which the authenticated user has access."
        in: path
        name: alertId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAlertConfigView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Alert Configurations Set for One Alert
      tags:
      - Alert Configurations
  /api/atlas/v2/groups/{groupId}/apiKeys:
    get:
      description: "Returns all organization API keys that you assigned to the specified\
        \ project. Users with the Project Owner role in the project associated with\
        \ the API key can use the organization API key to access the resources. To\
        \ use this resource, the requesting API Key must have the Project Owner role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: listProjectApiKeys
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiApiUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Organization API Keys Assigned to One Project
      tags:
      - Programmatic API Keys
    post:
      description: "Creates and assigns the specified organization API key to the\
        \ specified project. Users with the Project Owner role in the project associated\
        \ with the API key can use the organization API key to access the resources.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      operationId: createProjectApiKey
      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/CreateAtlasProjectApiKey'
        description: Organization API key to be created and assigned to the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiKeyUserDetails'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create and Assign One Organization API Key to One Project
      tags:
      - Programmatic API Keys
  /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}:
    delete:
      description: "Removes one organization API key from the specified project. To\
        \ use this resource, the requesting API Key must have the Project Owner role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: removeProjectApiKey
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key that you want to unassign from one project.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Unassign One Organization API Key from One Project
      tags:
      - Programmatic API Keys
    patch:
      description: Updates the roles of the organization API key that you specify
        for the project that you specify. You must specify at least one valid role
        for the project. The application removes any roles that you do not include
        in this request if they were previously set in the organization API key that
        you specify for the project.
      operationId: updateApiKeyRoles
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key that you want to unassign from one project.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/UpdateAtlasProjectApiKey'
        description: Organization API Key to be updated. This request requires a minimum
          of one of the two body parameters.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiKeyUserDetails'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Roles of One Organization API Key to One Project
      tags:
      - Programmatic API Keys
    post:
      description: "Assigns the specified organization API key to the specified project.\
        \ Users with the Project Owner role in the project associated with the API\
        \ key can then use the organization API key to access the resources. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: addProjectApiKey
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key that you want to assign to one project.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserAccessRoleAssignment'
        description: Organization API key to be assigned to the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiKeyUserDetails'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Assign One Organization API Key to One Project
      tags:
      - Programmatic API Keys
  /api/atlas/v2/groups/{groupId}/auditLog:
    get:
      description: "Returns the auditing configuration for the specified project.\
        \ The auditing configuration defines the events that MongoDB Cloud records\
        \ in the audit log. To use this resource, the requesting API Key must have\
        \ the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`,\
        \ or serverless clusters."
      operationId: getAuditingConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AuditLog'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return the Auditing Configuration for One Project
      tags:
      - Auditing
    patch:
      description: "Updates the auditing configuration for the specified project.\
        \ The auditing configuration defines the events that MongoDB Cloud records\
        \ in the audit log. To use this resource, the requesting API Key must have\
        \ the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`,\
        \ or serverless clusters."
      operationId: updateAuditingConfiguration
      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/AuditLog'
        description: Updated auditing configuration for the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AuditLog'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Auditing Configuration for One Project
      tags:
      - Auditing
  /api/atlas/v2/groups/{groupId}/awsCustomDNS:
    get:
      description: "Returns the custom DNS configuration for AWS clusters in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getAWSCustomDNS
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AWSCustomDNSEnabledView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Custom DNS Configuration for Atlas Clusters on AWS
      tags:
      - AWS Clusters DNS
    patch:
      description: "Enables or disables the custom DNS configuration for AWS clusters\
        \ in the specified project. Enable custom DNS if you use AWS VPC peering and\
        \ use your own DNS servers. To use this resource, the requesting API Key must\
        \ have the Project Atlas Admin role."
      operationId: toggleAWSCustomDNS
      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/AWSCustomDNSEnabledView'
        description: Enables or disables the custom DNS configuration for AWS clusters
          in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AWSCustomDNSEnabledView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Toggle State of One Custom DNS Configuration for Atlas Clusters on
        AWS
      tags:
      - AWS Clusters DNS
  /api/atlas/v2/groups/{groupId}/backup/exportBuckets:
    get:
      description: "Returns all AWS S3 buckets associated with the specified project.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: listExportBuckets
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedBackupSnapshotExportBucketView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All AWS S3 Buckets Used for Cloud Backup Snapshot Exports
      tags:
      - Cloud Backups
    post:
      description: "Grants MongoDB Cloud access to the specified AWS S3 bucket. This\
        \ enables this bucket to receive Atlas Cloud Backup snapshots. To use this\
        \ resource, the requesting API Key must have the Project Owner role."
      operationId: createExportBucket
      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/DiskBackupSnapshotAWSExportBucket'
        description: Grants MongoDB Cloud access to the specified AWS S3 bucket.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucket'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Grant Access to AWS S3 Bucket for Cloud Backup Snapshot Exports
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}:
    delete:
      description: "Revoke MongoDB Cloud access to the specified AWS S3 bucket. This\
        \ prevents this bucket to receive Atlas Cloud Backup snapshots. Auto export\
        \ must be disabled on all clusters in this project exporting to this bucket\
        \ before revoking access. To use this resource, the requesting API Key must\
        \ have the Project Owner role."
      operationId: deleteExportBucket
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Unique string that identifies the AWS S3 bucket to which you
          export your snapshots.
        in: path
        name: exportBucketId
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: "^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,61}[a-z0-9])$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Revoke Access to AWS S3 Bucket for Cloud Backup Snapshot Exports
      tags:
      - Cloud Backups
    get:
      description: "Returns one AWS S3 bucket associated with the specified project.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: getExportBucket
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Unique string that identifies the AWS S3 bucket to which you
          export your snapshots.
        in: path
        name: exportBucketId
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: "^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,61}[a-z0-9])$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucket'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One AWS S3 Bucket Used for Cloud Backup Snapshot Exports
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/backupCompliancePolicy:
    get:
      description: "Returns the Backup Compliance Policy settings with the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role. Deprecated versions: v2-{2023-01-01}"
      operationId: getDataProtectionSettings
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/DataProtectionSettings20231001'
              x-xgen-version: 2023-10-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return the Backup Compliance Policy settings
      tags:
      - Cloud Backups
    put:
      description: "Updates the Backup Compliance Policy settings for the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role. Deprecated versions: v2-{2023-01-01}"
      operationId: updateDataProtectionSettings
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Flag that indicates whether to overwrite non complying backup
          policies with the new data protection settings or not.
        in: query
        name: overwriteBackupPolicies
        schema:
          type: boolean
          default: true
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              $ref: '#/components/schemas/DataProtectionSettings20231001'
            x-xgen-version: 2023-10-01
        description: The new Backup Compliance Policy settings.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/DataProtectionSettings20231001'
              x-xgen-version: 2023-10-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update or enable the Backup Compliance Policy settings
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/cloudProviderAccess:
    get:
      description: "Returns all cloud provider access roles with access to the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: listCloudProviderAccessRoles
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderAccessRoles'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Cloud Provider Access Roles
      tags:
      - Cloud Provider Access
    post:
      description: "Creates one access role for the specified cloud provider. Some\
        \ MongoDB Cloud features use these cloud provider access roles for authentication.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      externalDocs:
        description: Set Up Access to Cloud Providers
        url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/
      operationId: createCloudProviderAccessRole
      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/CloudProviderAccessRole'
        description: Creates one role for the specified cloud provider.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderAccessRole'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
  /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}:
    delete:
      description: "Revokes access to the specified project for the specified access\
        \ role. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: deauthorizeCloudProviderAccessRole
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cloud provider of the
          role to deauthorize.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          enum:
          - AWS
      - description: Unique 24-hexadecimal digit string that identifies the role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: No Content
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Deauthorize One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
  /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}:
    get:
      description: "Returns the access role with the specified id and with access\
        \ to the specified project. To use this resource, the requesting API Key must\
        \ have the Project Owner role."
      operationId: getCloudProviderAccessRole
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderAccessRole'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return specified Cloud Provider Access Role
      tags:
      - Cloud Provider Access
    patch:
      description: "Grants access to the specified project for the specified access\
        \ role. To use this resource, the requesting API Key must have the Project\
        \ Owner role. This API endpoint is one step in a procedure to create unified\
        \ access for MongoDB Cloud services."
      externalDocs:
        description: Set Up Access to Cloud Providers
        url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/
      operationId: authorizeCloudProviderAccessRole
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CloudProviderAccessRole'
        description: Grants access to the specified project for the specified access
          role.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderAccessRole'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Authorize One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
  /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 multi-cloud clusters. To use this resource,\
        \ the requesting API Key must have the Project Read Only role. This feature\
        \ is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}"
      operationId: listClusters
      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:
          type: boolean
          default: false
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAdvancedClusterDescriptionView'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Clusters in One Project
      tags:
      - Clusters
    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\
        \ multi-cloud clusters. Each project supports up to 25 database deployments.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role. This feature is not available for serverless clusters. Deprecated\
        \ versions: v2-{2023-01-01}"
      operationId: createCluster
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            examples:
              Multi Cloud Cluster:
                description: Multi Cloud Cluster
                value:
                  clusterType: REPLICASET
                  links: []
                  name: multiCloud
                  replicationSpecs:
                  - numShards: 1
                    regionConfigs:
                    - analyticsAutoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M40
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      analyticsSpecs:
                        instanceSize: M30
                        nodeCount: 0
                      autoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M40
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      electableSpecs:
                        instanceSize: M30
                        nodeCount: 3
                      hiddenSecondarySpecs:
                        instanceSize: M30
                        nodeCount: 0
                      priority: 7
                      providerName: AWS
                      readOnlySpecs:
                        instanceSize: M30
                        nodeCount: 0
                      regionName: US_EAST_1
                    - analyticsAutoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M40
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      analyticsSpecs:
                        instanceSize: M30
                        nodeCount: 0
                      autoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M40
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      electableSpecs:
                        instanceSize: M30
                        nodeCount: 2
                      hiddenSecondarySpecs:
                        instanceSize: M30
                        nodeCount: 0
                      priority: 6
                      providerName: GCP
                      readOnlySpecs:
                        instanceSize: M30
                        nodeCount: 0
                      regionName: EASTERN_US
                    zoneName: Zone 1
            schema:
              $ref: '#/components/schemas/AdvancedClusterDescription'
        description: Cluster to create in the specific project.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/AdvancedClusterDescription'
              x-xgen-version: 2023-02-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "403":
          $ref: '#/components/responses/forbidden'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Cluster from One Project
      tags:
      - Clusters
  /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 API\
        \ Key must have the Project Read Only role."
      operationId: listCloudProviderRegions
      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:
          type: array
          items:
            type: string
      - 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
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Cloud Provider Regions
      tags:
      - Clusters
  /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade:
    post:
      description: "Upgrades a shared-tier cluster in the specified project. To use\
        \ this resource, the requesting API key must have the Project Cluster Manager\
        \ role. Each project supports up to 25 clusters."
      operationId: upgradeSharedCluster
      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
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "403":
          $ref: '#/components/responses/forbidden'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Upgrade One Shared-tier Cluster
      tags:
      - Clusters
  /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless:
    post:
      description: "Upgrades a shared-tier cluster to a serverless instance in the\
        \ specified project. To use this resource, the requesting API key must have\
        \ the Project Cluster Manager role."
      operationId: upgradeSharedClusterToServerless
      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
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "403":
          $ref: '#/components/responses/forbidden'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Upgrades One Shared-Tier Cluster to the Serverless Instance
      tags:
      - Clusters
  /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 API Key must have the Project Owner role. This\
        \ feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}"
      operationId: deleteCluster
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - 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
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Cluster from One Project
      tags:
      - Clusters
    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 multi-cloud clusters. To use this resource, the requesting API\
        \ Key must have the Project Read Only role. This feature is not available\
        \ for serverless clusters. Deprecated versions: v2-{2023-01-01}"
      operationId: getCluster
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/AdvancedClusterDescription'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Cluster from One Project
      tags:
      - Clusters
    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 multi-cloud clusters. To update a cluster's termination\
        \ protection, the requesting API Key must have the Project Owner role. For\
        \ all other updates, the requesting API Key must have the Project Cluster\
        \ 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-{2023-01-01}"
      operationId: updateCluster
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/AdvancedClusterDescription'
        description: Cluster to update in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/AdvancedClusterDescription'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Modify One Cluster from One Project
      tags:
      - Clusters
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports:
    get:
      description: "Returns all Cloud Backup snapshot export jobs associated with\
        \ the specified Atlas cluster. To use this resource, the requesting API Key\
        \ must have the Project Atlas Admin role."
      operationId: listBackupExportJobs
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Cloud Backup Snapshot Export Jobs
      tags:
      - Cloud Backups
    post:
      description: "Exports one backup snapshot for dedicated Atlas cluster using\
        \ Cloud Backups to an AWS bucket. To use this resource, the requesting API\
        \ Key must have the Project Atlas Admin role."
      operationId: createBackupExportJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DiskBackupExportJobRequest'
        description: Information about the Cloud Backup Snapshot Export Job to create.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupExportJob'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Cloud Backup Snapshot Export Job
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}:
    get:
      description: "Returns one Cloud Backup snapshot export job associated with the\
        \ specified Atlas cluster. To use this resource, the requesting API Key must\
        \ have the Project Atlas Admin role."
      operationId: getBackupExportJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique string that identifies the AWS S3 bucket to which you
          export your snapshots.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupExportJob'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Cloud Backup Snapshot Export Job
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs:
    get:
      description: "Returns all cloud backup restore jobs for one cluster from the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Owner role."
      operationId: listBackupRestoreJobs
      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: Human-readable label that identifies the cluster with the restore
          jobs you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedCloudBackupRestoreJobView'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Restore Jobs for One Cluster
      tags:
      - Cloud Backups
    post:
      description: |-
        Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.

         To use this resource, the requesting API Key must have the Project Owner role.
      operationId: createBackupRestoreJob
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob'
        description: Restores one snapshot of one cluster from the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Restore One Snapshot of One Cluster
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}:
    delete:
      description: "Cancels one cloud backup restore job of one cluster from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: cancelBackupRestoreJob
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to remove.
        in: path
        name: restoreJobId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "405":
          $ref: '#/components/responses/methodNotAllowed'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Cancel One Restore Job of One Cluster
      tags:
      - Cloud Backups
    get:
      description: "Returns one cloud backup restore job for one cluster from the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Owner role."
      operationId: getBackupRestoreJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cluster with the restore
          jobs you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to return.
        in: path
        name: restoreJobId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Restore Job of One Cluster
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule:
    delete:
      description: "Removes all cloud backup schedules for the specified cluster.\
        \ This schedule defines when MongoDB Cloud takes scheduled snapshots and how\
        \ long it stores those snapshots. To use this resource, the requesting API\
        \ Key must have the Project Atlas Admin role."
      operationId: deleteAllBackupSchedules
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotSchedule'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove All Cloud Backup Schedules
      tags:
      - Cloud Backups
    get:
      description: "Returns the cloud backup schedule for the specified cluster within\
        \ the specified project. This schedule defines when MongoDB Cloud takes scheduled\
        \ snapshots and how long it stores those snapshots. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: getBackupSchedule
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotSchedule'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Cloud Backup Schedule
      tags:
      - Cloud Backups
    patch:
      description: "Updates the cloud backup schedule for one cluster within the specified\
        \ project. This schedule defines when MongoDB Cloud takes scheduled snapshots\
        \ and how long it stores those snapshots. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: updateBackupSchedule
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DiskBackupSnapshotSchedule'
        description: |-
          Updates the cloud backup schedule for one cluster within the specified project.

          **Note**: In the request body, provide only the fields that you want to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshotSchedule'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Cloud Backup Schedule for One Cluster
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots:
    get:
      description: "Returns all snapshots of one cluster from the specified project.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: listReplicaSetBackups
      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: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedCloudBackupReplicaSetView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Replica Set Cloud Backups
      tags:
      - Cloud Backups
    post:
      description: |-
        Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.

         To use this resource, the requesting API Key must have the Project Owner role.
      operationId: takeSnapshot
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DiskBackupOnDemandSnapshotRequest'
        description: Takes one on-demand snapshot.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupSnapshot'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Take One On-Demand Snapshot
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}:
    delete:
      description: "Removes one snapshot of one sharded cluster from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: deleteShardedClusterBackup
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Sharded Cluster Cloud Backup
      tags:
      - Cloud Backups
    get:
      description: "Returns one snapshot of one sharded cluster from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getShardedClusterBackup
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupShardedClusterSnapshot'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Sharded Cluster Cloud Backup
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters:
    get:
      description: "Returns all snapshots of one sharded cluster from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: listShardedClusterBackups
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Sharded Cluster Cloud Backups
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}:
    delete:
      description: "Removes the specified snapshot. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: deleteReplicaSetBackup
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Replica Set Cloud Backup
      tags:
      - Cloud Backups
    get:
      description: "Returns one snapshot from the specified cluster. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: getReplicaSetBackup
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupReplicaSet'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Replica Set Cloud Backup
      tags:
      - Cloud Backups
    patch:
      description: Changes the expiration date for one cloud backup snapshot for one
        cluster in the specified project.
      operationId: updateSnapshotRetention
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/BackupSnapshotRetention'
        description: Changes the expiration date for one cloud backup snapshot for
          one cluster in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DiskBackupReplicaSet'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Change Expiration Date for One Cloud Backup
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download:
    post:
      description: "Requests one snapshot for the specified shared cluster. This resource\
        \ returns a `snapshotURL` that you can use to download the snapshot. This\
        \ `snapshotURL` remains active for four hours after you make the request.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      operationId: downloadSharedClusterBackup
      parameters:
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - $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/TenantRestore'
        description: Snapshot to be downloaded.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TenantRestore'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Download One M2 or M5 Cluster Snapshot
      tags:
      - Shared-Tier Snapshots
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore:
    post:
      description: "Restores the specified cluster. MongoDB Cloud limits which clusters\
        \ can be the target clusters of a restore. The target cluster can't use encryption\
        \ at rest, run a major release MongoDB version different than the snapshot,\
        \ or receive client requests during restores. MongoDB Cloud deletes all existing\
        \ data on the target cluster prior to the restore operation. To use this resource,\
        \ the requesting API Key must have the Project Owner role."
      operationId: createSharedClusterBackupRestoreJob
      parameters:
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - $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/TenantRestore'
        description: The restore job details.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TenantRestore'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Restore Job from One M2 or M5 Cluster
      tags:
      - Shared-Tier Restore Jobs
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores:
    get:
      description: "Returns all restore jobs for the specified M2 or M5 cluster. Restore\
        \ jobs restore a cluster using a snapshot. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      operationId: listSharedClusterBackupRestoreJobs
      parameters:
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedTenantRestoreView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Restore Jobs for One M2 or M5 Cluster
      tags:
      - Shared-Tier Restore Jobs
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}:
    get:
      description: "Returns the specified restore job. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      operationId: getSharedClusterBackupRestoreJob
      parameters:
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to return.
        in: path
        name: restoreId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TenantRestore'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Restore Job for One M2 or M5 Cluster
      tags:
      - Shared-Tier Restore Jobs
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots:
    get:
      description: "Returns details for all snapshots for the specified shared cluster.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: listSharedClusterBackups
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedTenantSnapshotView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Snapshots for One M2 or M5 Cluster
      tags:
      - Shared-Tier Snapshots
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}:
    get:
      description: "Returns details for one snapshot for the specified shared cluster.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: getSharedClusterBackup
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupTenantSnapshot'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Snapshot for One M2 or M5 Cluster
      tags:
      - Shared-Tier Snapshots
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints:
    get:
      deprecated: true
      description: "Returns all legacy backup checkpoints for one cluster in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: listLegacyBackupCheckpoints
      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: Human-readable label that identifies the cluster that contains
          the checkpoints that you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAtlasCheckpointView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Legacy Backup Checkpoints
      tags:
      - Legacy Backup
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}:
    get:
      deprecated: true
      description: "Returns one legacy backup checkpoint for one cluster in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getLegacyBackupCheckpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the checkpoint.
        in: path
        name: checkpointId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Human-readable label that identifies the cluster that contains
          the checkpoints that you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiAtlasCheckpointView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Legacy Backup Checkpoint
      tags:
      - Legacy Backup
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned:
    get:
      description: "Returns a list of given cluster's pinned namespaces, a set of\
        \ namespaces manually selected by users to collect query latency metrics on."
      operationId: getPinnedNamespaces
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: Human-readable label that identifies the cluster to retrieve
          pinned namespaces for.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/PinnedNamespaces'
              x-xgen-version: 2023-11-15
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Pinned Namespaces
      tags:
      - Collection Level Metrics
    patch:
      description: Add provided list of namespaces to existing pinned namespaces list
        for collection-level latency metrics collection for the given Group and Cluster
      operationId: pinNamespacesPatch
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: Human-readable label that identifies the cluster to pin namespaces
          to.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-11-15+json:
            schema:
              $ref: '#/components/schemas/NamespacesRequest'
        description: List of namespace strings (combination of database and collection
          name) to pin for query latency metric collection.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/PinnedNamespaces'
              x-xgen-version: 2023-11-15
          description: OK
        "201":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/PinnedNamespaces'
              x-xgen-version: 2023-11-15
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Add Pinned Namespaces
      tags:
      - Collection Level Metrics
    put:
      description: Pin provided list of namespaces for collection-level latency metrics
        collection for the given Group and Cluster. This initializes a pinned namespaces
        list or replaces any existing pinned namespaces list for the Group and Cluster.
      operationId: pinNamespacesPut
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: Human-readable label that identifies the cluster to pin namespaces
          to.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-11-15+json:
            schema:
              $ref: '#/components/schemas/NamespacesRequest'
        description: List of namespace strings (combination of database and collection
          name) to pin for query latency metric collection.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/PinnedNamespaces'
              x-xgen-version: 2023-11-15
          description: OK
        "201":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/PinnedNamespaces'
              x-xgen-version: 2023-11-15
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Pin Namespaces
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin:
    patch:
      description: Unpin provided list of namespaces for collection-level latency
        metrics collection for the given Group and Cluster
      operationId: unpinNamespaces
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: Human-readable label that identifies the cluster to unpin namespaces
          from.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-11-15+json:
            schema:
              $ref: '#/components/schemas/NamespacesRequest'
        description: List of namespace strings (combination of database and collection
          name) to pin for query latency metric collection.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/PinnedNamespaces'
              x-xgen-version: 2023-11-15
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Unpin namespaces
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes:
    post:
      description: "Creates one Atlas Search index on the specified collection. Atlas\
        \ Search indexes define the fields on which to create the index and the analyzers\
        \ to use when creating the index. Only clusters running MongoDB v4.2 or later\
        \ can use Atlas Search. To use this resource, the requesting API Key must\
        \ have the Project Data Access Admin role."
      externalDocs:
        description: Atlas Search Indexes
        url: https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/
      operationId: createAtlasSearchIndex
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Name of the cluster that contains the collection on which to
          create an Atlas Search index.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ClusterSearchIndex'
        description: Creates one Atlas Search index on the specified collection.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterSearchIndex'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Atlas Search Index
      tags:
      - Atlas Search
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}:
    get:
      description: "Returns all Atlas Search indexes on the specified collection.\
        \ Atlas Search indexes contain the indexed fields and the analyzers used to\
        \ create the indexes. To use this resource, the requesting API Key must have\
        \ the Project Data Access Read Write role."
      externalDocs:
        description: Atlas Search Indexes
        url: https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/
      operationId: listAtlasSearchIndexes
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Name of the cluster that contains the collection with one or
          more Atlas Search indexes.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Name of the collection that contains one or more Atlas Search
          indexes.
        in: path
        name: collectionName
        required: true
        schema:
          type: string
      - description: Human-readable label that identifies the database that contains
          the collection with one or more Atlas Search indexes.
        in: path
        name: databaseName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterSearchIndex'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Atlas Search Indexes for One Collection
      tags:
      - Atlas Search
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}:
    delete:
      description: "Removes one Atlas Search index that you identified with its unique\
        \ ID. To use this resource, the requesting API Key must have the Project Data\
        \ Access Admin role."
      externalDocs:
        description: Atlas Search Indexes
        url: https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/
      operationId: deleteAtlasSearchIndex
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Name of the cluster that contains the database and collection
          with one or more Application Search indexes.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: "Unique 24-hexadecimal digit string that identifies the Atlas\
          \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\
          \ endpoint to find the IDs of all Atlas Search indexes."
        in: path
        name: indexId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Atlas Search Index
      tags:
      - Atlas Search
    get:
      description: "Returns one Atlas Search index in the specified project. You identify\
        \ this index using its unique ID. Atlas Search index contains the indexed\
        \ fields and the analyzers used to create the index. To use this resource,\
        \ the requesting API Key must have the Project Data Access Read Write role."
      externalDocs:
        description: Atlas Search Indexes
        url: https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/
      operationId: getAtlasSearchIndex
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Name of the cluster that contains the collection with one or
          more Atlas Search indexes.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: "Unique 24-hexadecimal digit string that identifies the Application\
          \ Search [index](https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/).\
          \ Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\
          \ endpoint to find the IDs of all Application Search indexes."
        in: path
        name: indexId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterSearchIndex'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Atlas Search Index
      tags:
      - Atlas Search
    patch:
      description: "Updates one Atlas Search index that you identified with its unique\
        \ ID. Atlas Search indexes define the fields on which to create the index\
        \ and the analyzers to use when creating the index. To use this resource,\
        \ the requesting API Key must have the Project Data Access Admin role."
      externalDocs:
        description: Atlas Search Indexes
        url: https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/
      operationId: updateAtlasSearchIndex
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Name of the cluster that contains the collection whose Atlas
          Search index to update.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: "Unique 24-hexadecimal digit string that identifies the Atlas\
          \ Search [index](https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/).\
          \ Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\
          \ endpoint to find the IDs of all Atlas Search indexes."
        in: path
        name: indexId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ClusterSearchIndex'
        description: Details to update on the Atlas Search index.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterSearchIndex'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Atlas Search Index
      tags:
      - Atlas Search
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites:
    get:
      description: "Returns one managed namespace within the specified global cluster.\
        \ A managed namespace identifies a collection using the database name, the\
        \ dot separator, and the collection name. To use this resource, the requesting\
        \ 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: getManagedNamespace
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/GeoSharding'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Managed Namespace in One Global Cluster
      tags:
      - Global Clusters
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping:
    delete:
      description: "Removes all custom zone mappings for the specified global cluster.\
        \ A custom zone mapping matches one ISO 3166-2 location code to a zone in\
        \ your global cluster. Removing the custom zone mappings restores the default\
        \ mapping. By default, MongoDB Cloud maps each location code to the closest\
        \ geographical zone. To use this resource, the requesting API Key must have\
        \ the Project Owner role. Deprecated versions: v2-{2023-01-01}"
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: deleteAllCustomZoneMappings
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/GeoSharding'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove All Custom Zone Mappings from One Global Cluster
      tags:
      - Global Clusters
    post:
      description: "Creates one custom zone mapping for the specified global cluster.\
        \ A custom zone mapping matches one ISO 3166-2 location code to a zone in\
        \ your global cluster. By default, MongoDB Cloud maps each location code to\
        \ the closest geographical zone. To use this resource, the requesting API\
        \ Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}"
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: createCustomZoneMapping
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/CustomZoneMappings'
        description: Custom zone mapping to add to the specified global cluster.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/GeoSharding'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Add One Entry to One Custom Zone Mapping
      tags:
      - Global Clusters
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces:
    delete:
      description: "Removes one managed namespace within the specified global cluster.\
        \ A managed namespace identifies a collection using the database name, the\
        \ dot separator, and the collection name. Deleting a managed namespace does\
        \ not remove the associated collection or data. To use this resource, the\
        \ requesting API Key must have the Project Data Access Admin role. Deprecated\
        \ versions: v2-{2023-01-01}"
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: deleteManagedNamespace
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the database that contains
          the collection.
        in: query
        name: db
        schema:
          type: string
      - description: Human-readable label that identifies the collection associated
          with the managed namespace.
        in: query
        name: collection
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/GeoSharding'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Managed Namespace from One Global Cluster
      tags:
      - Global Clusters
    post:
      description: "Creates one managed namespace within the specified global cluster.\
        \ A managed namespace identifies a collection using the database name, the\
        \ dot separator, and the collection name. To use this resource, the requesting\
        \ API Key must have the Project Data Access Admin role. Deprecated versions:\
        \ v2-{2023-01-01}"
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: createManagedNamespace
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/ManagedNamespaceView'
        description: Managed namespace to create within the specified global cluster.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/GeoSharding'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "405":
          $ref: '#/components/responses/methodNotAllowed'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Managed Namespace in One Global Cluster
      tags:
      - Global Clusters
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index:
    post:
      description: "Creates an index on the cluster identified by its name in a rolling\
        \ manner. Creating the index in this way allows index builds on one replica\
        \ set member as a standalone at a time, starting with the secondary members.\
        \ Creating indexes in this way requires at least one replica set election.\
        \ To use this resource, the requesting API Key must have the Project Data\
        \ Access Admin role."
      externalDocs:
        description: Rolling Index Builds on Replica Sets
        url: https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/
      operationId: createRollingIndex
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cluster on which MongoDB
          Cloud creates an index.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            examples:
              "2dspere Index":
                description: 2dspere Index
                value:
                  collation:
                    alternate: non-ignorable
                    backwards: false
                    caseFirst: lower
                    caseLevel: false
                    locale: af
                    maxVariable: punct
                    normalization: false
                    numericOrdering: false
                    strength: 3
                  collection: accounts
                  db: sample_airbnb
                  keys:
                  - property_type: "1"
                  options:
                    name: PartialIndexTest
                    partialFilterExpression:
                      limit:
                        $gt: 900
              Partial Index:
                description: Partial Index
                value:
                  collation:
                    alternate: non-ignorable
                    backwards: false
                    caseFirst: lower
                    caseLevel: false
                    locale: af
                    maxVariable: punct
                    normalization: false
                    numericOrdering: false
                    strength: 3
                  collection: accounts
                  db: sample_airbnb
                  keys:
                  - property_type: "1"
                  options:
                    name: PartialIndexTest
                    partialFilterExpression:
                      limit:
                        $gt: 900
              Sparse Index:
                description: Sparse Index
                value:
                  collation:
                    alternate: non-ignorable
                    backwards: false
                    caseFirst: lower
                    caseLevel: false
                    locale: af
                    maxVariable: punct
                    normalization: false
                    numericOrdering: false
                    strength: 3
                  collection: accounts
                  db: sample_airbnb
                  keys:
                  - test_field: "1"
                  options:
                    name: SparseIndexTest
                    sparse: true
            schema:
              $ref: '#/components/schemas/DatabaseRollingIndexRequest'
        description: Rolling index to create on the specified cluster.
        required: true
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: Accepted
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Rolling Index
      tags:
      - Rolling Index
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives:
    get:
      description: "Returns details of all online archives. This archive stores data\
        \ from one cluster within one project. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: listOnlineArchives
      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: Human-readable label that identifies the cluster that contains
          the collection for which you want to return the online archives.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedOnlineArchiveView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Online Archives for One Cluster
      tags:
      - Online Archive
    post:
      description: "Creates one online archive. This archive stores data from one\
        \ cluster within one project. To use this resource, the requesting API Key\
        \ must have the Project Data Access Admin role."
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: createOnlineArchive
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cluster that contains
          the collection for which you want to create one online archive.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/BackupOnlineArchiveCreate'
        description: Creates one online archive.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupOnlineArchive'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Online Archive
      tags:
      - Online Archive
      x-xgen-changelog:
        "2023-08-02": "If 'criteria':'DATE' is specified, then you must specify 'DATE'\
          \ values in partition fields"
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz:
    get:
      description: "Downloads query logs for the specified online archive. To use\
        \ this resource, the requesting API Key must have the Project Data Access\
        \ Read Only or higher role."
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: downloadOnlineArchiveQueryLogs
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: "Date and time that specifies the starting point for the range\
          \ of log messages to return. This resource expresses this value in the number\
          \ of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time)."
        in: query
        name: startDate
        schema:
          type: integer
          format: int64
          example: 1636481348
          minimum: 1199145600
      - description: "Date and time that specifies the end point for the range of\
          \ log messages to return. This resource expresses this value in the number\
          \ of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time)."
        in: query
        name: endDate
        schema:
          type: integer
          format: int64
          example: 1636481348
          minimum: 1199145600
      - description: Human-readable label that identifies the cluster that contains
          the collection for which you want to return the query logs from one online
          archive.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Flag that indicates whether to download logs for queries against
          your online archive only or both your online archive and cluster.
        in: query
        name: archiveOnly
        schema:
          type: boolean
          default: false
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+gzip:
              schema:
                type: string
                format: binary
                description: This resource downloads a compressed log file to your
                  current working directory. You can specify its name using the `--output`
                  option or use the default filename using the `-OJ` option. The default
                  filename varies based on whether you download logs for queries of
                  your online archive only or both your online archive and cluster.
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Download Online Archive Query Logs
      tags:
      - Online Archive
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}:
    delete:
      description: "Removes one online archive. This archive stores data from one\
        \ cluster within one project. To use this resource, the requesting API Key\
        \ must have the Project Data Access Admin role."
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: deleteOnlineArchive
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the online
          archive to delete.
        in: path
        name: archiveId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Human-readable label that identifies the cluster that contains
          the collection from which you want to remove an online archive.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Online Archive
      tags:
      - Online Archive
    get:
      description: "Returns one online archive for one cluster. This archive stores\
        \ data from one cluster within one project. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: getOnlineArchive
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the online
          archive to return.
        in: path
        name: archiveId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Human-readable label that identifies the cluster that contains
          the specified collection from which Application created the online archive.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupOnlineArchive'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Online Archive
      tags:
      - Online Archive
    patch:
      description: "Updates, pauses, or resumes one online archive. This archive stores\
        \ data from one cluster within one project. To use this resource, the requesting\
        \ API Key must have the Project Data Access Admin role."
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: updateOnlineArchive
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the online
          archive to update.
        in: path
        name: archiveId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Human-readable label that identifies the cluster that contains
          the specified collection from which Application created the online archive.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/BackupOnlineArchive'
        description: "Updates, pauses, or resumes one online archive."
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupOnlineArchive'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Online Archive
      tags:
      - Online Archive
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation:
    delete:
      description: Ends a cluster outage simulation.
      externalDocs:
        description: Cluster Outage Simulation
        url: https://dochub.mongodb.org/core/test-regional-outage
      operationId: endOutageSimulation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster that is undergoing
          outage simulation.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterOutageSimulation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: End an Outage Simulation
      tags:
      - Cluster Outage Simulation
    get:
      description: Returns one outage simulation for one cluster.
      externalDocs:
        description: Cluster Outage Simulation
        url: https://dochub.mongodb.org/core/test-regional-outage
      operationId: getOutageSimulation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster that is undergoing
          outage simulation.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterOutageSimulation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Outage Simulation
      tags:
      - Cluster Outage Simulation
    post:
      description: Starts a cluster outage simulation.
      externalDocs:
        description: Cluster Outage Simulation
        url: https://dochub.mongodb.org/core/test-regional-outage
      operationId: startOutageSimulation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster to undergo an
          outage simulation.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ClusterOutageSimulation'
        description: Describes the outage simulation.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterOutageSimulation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Start an Outage Simulation
      tags:
      - Cluster Outage Simulation
  /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, or\
        \ serverless clusters. To use this resource, the requesting API Key must have\
        \ the Project Read Only role."
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: getClusterAdvancedConfiguration
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterDescriptionProcessArgs'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Advanced Configuration Options for One Cluster
      tags:
      - Clusters
    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 API Key must have the Project Cluster Manager role. This\
        \ feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier\
        \ clusters, or serverless clusters."
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: updateClusterAdvancedConfiguration
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ClusterDescriptionProcessArgs'
        description: Advanced configuration details to add for one cluster in the
          specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterDescriptionProcessArgs'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Advanced Configuration Options for One Cluster
      tags:
      - Clusters
  /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 API Key must\
        \ have the Project Cluster Manager role. Deprecated versions: v2-{2023-01-01}"
      operationId: testFailover
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Test Failover for One Cluster
      tags:
      - Clusters
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs:
    get:
      deprecated: true
      description: |-
        Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

         Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.
      operationId: listLegacyBackupRestoreJobs
      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: "Unique 24-hexadecimal digit string that identifies the batch\
          \ of restore jobs to return. Timestamp in ISO 8601 date and time format\
          \ in UTC when creating a restore job for a sharded cluster, Application\
          \ creates a separate job for each shard, plus another for the config host.\
          \ Each of these jobs comprise one batch. A restore job for a replica set\
          \ can't be part of a batch."
        in: query
        name: batchId
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Human-readable label that identifies the cluster with the snapshot
          you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedRestoreJobView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Legacy Backup Restore Jobs
      tags:
      - Legacy Backup
    post:
      deprecated: true
      description: "Restores one legacy backup for one cluster in the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role. Effective 23 March 2020, all new clusters can use only Cloud Backups.\
        \ When you upgrade to 4.2, your backup system upgrades to cloud backup if\
        \ it is currently set to legacy backup. After this upgrade, all your existing\
        \ legacy backup snapshots remain available. They expire over time in accordance\
        \ with your retention policy. Your backup policy resets to the default schedule.\
        \ If you had a custom backup policy in place with legacy backups, you must\
        \ re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).\
        \ This endpoint doesn't support creating checkpoint restore jobs for sharded\
        \ clusters, or creating restore jobs for queryable backup snapshots. If you\
        \ create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE`\
        \ in your request body, MongoDB Cloud removes all existing data on the target\
        \ cluster prior to the restore."
      operationId: createLegacyBackupRestoreJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cluster with the snapshot
          you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/BackupRestoreJob'
        description: Legacy backup to restore to one cluster in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedRestoreJobView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Legacy Backup Restore Job
      tags:
      - Legacy Backup
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}:
    get:
      deprecated: true
      description: |-
        Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

         Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).
      operationId: getLegacyBackupRestoreJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cluster with the snapshot
          you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job.
        in: path
        name: jobId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupRestoreJob'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Legacy Backup Restore Job
      tags:
      - Legacy Backup
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment:
    delete:
      description: Deletes the Search Nodes for the specified cluster.
      operationId: deleteAtlasSearchDeployment
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Label that identifies the cluster to delete.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete Search Nodes
      tags:
      - Atlas Search
    get:
      description: Return the Search Nodes for the specified cluster.
      operationId: getAtlasSearchDeployment
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Label that identifies the cluster to return the Search Nodes
          for.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiSearchDeploymentResponseView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Search Nodes
      tags:
      - Atlas Search
    patch:
      description: Updates the Search Nodes for the specified cluster.
      operationId: updateAtlasSearchDeployment
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Label that identifies the cluster to update the Search Nodes
          for.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ApiSearchDeploymentRequestView'
        description: Updates the Search Nodes for the specified cluster.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiSearchDeploymentResponseView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Search Nodes
      tags:
      - Atlas Search
    post:
      description: Creates Search Nodes for the specified cluster.
      operationId: createAtlasSearchDeployment
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Label that identifies the cluster to create Search Nodes for.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ApiSearchDeploymentRequestView'
        description: Creates Search Nodes for the specified cluster.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiSearchDeploymentResponseView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create Search Nodes
      tags:
      - Atlas Search
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule:
    get:
      deprecated: true
      description: |-
        Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

         Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).
      operationId: getLegacySnapshotSchedule
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the cluster with the snapshot
          you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiAtlasSnapshotScheduleView'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Snapshot Schedule
      tags:
      - Legacy Backup
    patch:
      deprecated: true
      description: |-
        Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.

         Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).
      operationId: updateLegacySnapshotSchedule
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster with the snapshot
          you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ApiAtlasSnapshotScheduleView'
        description: Update the snapshot schedule for one cluster in the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiAtlasSnapshotScheduleView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Snapshot Schedule for One Cluster
      tags:
      - Legacy Backup
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots:
    get:
      deprecated: true
      description: "Returns all legacy backup snapshots for one cluster in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role. Effective 23 March 2020, all new clusters can use only Cloud\
        \ Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup\
        \ if it is currently set to legacy backup. After this upgrade, all your existing\
        \ legacy backup snapshots remain available. They expire over time in accordance\
        \ with your retention policy. Your backup policy resets to the default schedule.\
        \ If you had a custom backup policy in place with legacy backups, you must\
        \ re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule)."
      operationId: listLegacySnapshots
      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: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: "Human-readable label that specifies whether to return only completed,\
          \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\
          \ snapshots."
        in: query
        name: completed
        schema:
          type: string
          default: "true"
          enum:
          - all
          - "true"
          - "false"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedSnapshotView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Legacy Backup Snapshots
      tags:
      - Legacy Backup
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}:
    delete:
      deprecated: true
      description: "Removes one legacy backup snapshot for one cluster in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role. Effective 23 March 2020, all new clusters can use only Cloud\
        \ Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup\
        \ if it is currently set to legacy backup. After this upgrade, all your existing\
        \ legacy backup snapshots remain available. They expire over time in accordance\
        \ with your retention policy. Your backup policy resets to the default schedule.\
        \ If you had a custom backup policy in place with legacy backups, you must\
        \ re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule)."
      operationId: deleteLegacySnapshot
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Legacy Backup Snapshot
      tags:
      - Legacy Backup
    get:
      deprecated: true
      description: "Returns one legacy backup snapshot for one cluster in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role. Effective 23 March 2020, all new clusters can use only Cloud\
        \ Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup\
        \ if it is currently set to legacy backup. After this upgrade, all your existing\
        \ legacy backup snapshots remain available. They expire over time in accordance\
        \ with your retention policy. Your backup policy resets to the default schedule.\
        \ If you had a custom backup policy in place with legacy backups, you must\
        \ re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule)."
      operationId: getLegacySnapshot
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupSnapshot'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Legacy Backup Snapshot
      tags:
      - Legacy Backup
    patch:
      deprecated: true
      description: "Changes the expiration date for one legacy backup snapshot for\
        \ one cluster in the specified project. To use this resource, the requesting\
        \ API Key must have the Project Owner role. Effective 23 March 2020, all new\
        \ clusters can use only Cloud Backups. When you upgrade to 4.2, your backup\
        \ system upgrades to cloud backup if it is currently set to legacy backup.\
        \ After this upgrade, all your existing legacy backup snapshots remain available.\
        \ They expire over time in accordance with your retention policy. Your backup\
        \ policy resets to the default schedule. If you had a custom backup policy\
        \ in place with legacy backups, you must re-create it with the procedure outlined\
        \ in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule)."
      operationId: updateLegacySnapshotRetention
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/BackupSnapshot'
        description: Changes One Legacy Backup Snapshot Expiration.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BackupSnapshot'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Change One Legacy Backup Snapshot Expiration
      tags:
      - Legacy Backup
  /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 API Key must have the Project Read Only role."
      operationId: getClusterStatus
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ClusterStatus'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Status of All Cluster Operations
      tags:
      - Clusters
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces:
    get:
      description: Return the subset of namespaces from the given cluster sorted by
        highest total execution time (descending) within the given time window.
      operationId: getCollStatsLatencyNamespacesForCluster
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster to pin namespaces
          to.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Human-readable label that identifies the cluster topology to
          retrieve metrics for.
        in: path
        name: clusterView
        required: true
        schema:
          type: string
          enum:
          - PRIMARY
          - SECONDARY
          - INDIVIDUAL_PROCESS
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/period'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/CollStatsRankedNamespacesView'
              x-xgen-version: 2023-11-15
          description: Succeeded
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Ranked Namespaces from a Cluster
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements:
    get:
      description: Get a list of the Coll Stats Latency cluster-level measurements
        for the given namespace.
      operationId: getCollStatsLatencyNamespaceClusterMeasurements
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster to retrieve
          metrics for.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Human-readable label that identifies the cluster topology to
          retrieve metrics for.
        in: path
        name: clusterView
        required: true
        schema:
          type: string
          enum:
          - PRIMARY
          - SECONDARY
          - INDIVIDUAL_PROCESS
      - $ref: '#/components/parameters/databaseName'
      - $ref: '#/components/parameters/collectionName'
      - $ref: '#/components/parameters/envelope'
      - description: "List that contains the metrics that you want to retrieve for\
          \ the associated data series. If you don't set this parameter, this resource\
          \ returns data series for all Coll Stats Latency metrics."
        in: query
        name: metrics
        schema:
          type: array
          items:
            type: string
            description: Metric requested for the given cluster
            enum:
            - READS_OPS
            - READS_LATENCY
            - AVERAGE_READS_LATENCY
            - READS_P50_VALUE
            - READS_P95_VALUE
            - READS_P99_VALUE
            - WRITES_OPS
            - WRITES_LATENCY
            - AVERAGE_WRITES_LATENCY
            - WRITES_P50_VALUE
            - WRITES_P95_VALUE
            - WRITES_P99_VALUE
            - COMMANDS_OPS
            - COMMANDS_LATENCY
            - AVERAGE_COMMANDS_LATENCY
            - COMMANDS_P50_VALUE
            - COMMANDS_P95_VALUE
            - COMMANDS_P99_VALUE
            - TOTAL_OPS
            - TOTAL_LATENCY
            - AVERAGE_TOTAL_OPS_LATENCY
            - TOTAL_OPS_P50_VALUE
            - TOTAL_OPS_P95_VALUE
            - TOTAL_OPS_P99_VALUE
          uniqueItems: true
        style: form
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/period'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/MeasurementsCollStatsLatencyCluster'
              x-xgen-version: 2023-11-15
          description: Succeeded
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Cluster-Level Query Latency
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz:
    get:
      description: "Returns a compressed (.gz) log file that contains a range of log\
        \ messages for the specified host for the specified project. MongoDB updates\
        \ process and audit logs from the cluster backend infrastructure every five\
        \ minutes and contain log data from the previous five minutes. If you poll\
        \ the API for log files, we recommend polling every five minutes. For example,\
        \ if the logs are updated at 4:00 UTC and then you poll the API, the API returns\
        \ log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't\
        \ available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To\
        \ use this resource, the requesting API Key must have the Project Data Access\
        \ Read Only or higher role. Deprecated versions: v2-{2023-01-01}"
      operationId: getHostLogs
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the host that stores the
          log files that you want to download.
        in: path
        name: hostName
        required: true
        schema:
          type: string
          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]+)?$"
      - description: "Human-readable label that identifies the log file that you want\
          \ to return. To return audit logs, enable *Database Auditing* for the specified\
          \ project."
        in: path
        name: logName
        required: true
        schema:
          type: string
          enum:
          - mongodb
          - mongos
          - mongodb-audit-log
          - mongos-audit-log
          externalDocs:
            description: Set up Database Auditing
            url: https://docs.atlas.mongodb.com/database-auditing/
      - description: Date and time when the period specifies the inclusive ending
          point for the range of log messages to retrieve. This parameter expresses
          its value in the number of seconds that have elapsed since the UNIX epoch.
        in: query
        name: endDate
        schema:
          type: integer
          format: int64
          minimum: 1199145600
      - description: Date and time when the period specifies the inclusive starting
          point for the range of log messages to retrieve. This parameter expresses
          its value in the number of seconds that have elapsed since the UNIX epoch.
        in: query
        name: startDate
        schema:
          type: integer
          format: int64
          minimum: 1199145600
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+gzip:
              schema:
                type: string
                format: binary
                description: Compressed (.gz) log file that contains a range of log
                  messages for the specified host for the specified project
              x-xgen-version: 2023-02-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Download Logs for One Cluster Host in One Project
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/collStats/metrics:
    get:
      description: Returns all available Coll Stats Latency metric names and their
        respective units for the specified project at the time of request.
      operationId: getCollStatsLatencyNamespaceMetrics
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-11-15
          description: Succeeded
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return all metric names
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/containers:
    get:
      description: "Returns details about all network peering containers in the specified\
        \ project for the specified cloud provider. If you do not specify the cloud\
        \ provider, MongoDB Cloud returns details about all network peering containers\
        \ in the project for Amazon Web Services (AWS). To use this resource, the\
        \ requesting API Key must have the Project Read Only role."
      operationId: listPeeringContainerByCloudProvider
      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 service provider that serves the desired network peering
          containers.
        in: query
        name: providerName
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedCloudProviderContainerView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Network Peering Containers in One Project for One Cloud
        Provider
      tags:
      - Network Peering
    post:
      description: "Creates one new network peering container in the specified project.\
        \ MongoDB Cloud can deploy Network Peering connections in a network peering\
        \ container. GCP can have one container per project. AWS and Azure can have\
        \ one container per cloud provider region. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: createPeeringContainer
      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/CloudProviderContainer'
        description: Creates one new network peering container in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderContainer'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One New Network Peering Container
      tags:
      - Network Peering
  /api/atlas/v2/groups/{groupId}/containers/all:
    get:
      description: "Returns details about all network peering containers in the specified\
        \ project. Network peering containers contain network peering connections.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: listPeeringContainers
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedCloudProviderContainerView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Network Peering Containers in One Project
      tags:
      - Network Peering
  /api/atlas/v2/groups/{groupId}/containers/{containerId}:
    delete:
      description: "Removes one network peering container in the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      operationId: deletePeeringContainer
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the MongoDB
          Cloud network container that you want to remove.
        in: path
        name: containerId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Network Peering Container
      tags:
      - Network Peering
    get:
      description: "Returns details about one network peering container in one specified\
        \ project. Network peering containers contain network peering connections.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: getPeeringContainer
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the MongoDB
          Cloud network container that you want to remove.
        in: path
        name: containerId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderContainer'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Network Peering Container
      tags:
      - Network Peering
    patch:
      description: "Updates the network details and labels of one specified network\
        \ peering container in the specified project. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: updatePeeringContainer
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the MongoDB
          Cloud network container that you want to remove.
        in: path
        name: containerId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CloudProviderContainer'
        description: Updates the network details and labels of one specified network
          peering container in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudProviderContainer'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Network Peering Container
      tags:
      - Network Peering
  /api/atlas/v2/groups/{groupId}/customDBRoles/roles:
    get:
      description: "Returns all custom roles for the specified project. To use this\
        \ resource, the requesting API Key must have the Project Read Only role."
      operationId: listCustomDatabaseRoles
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserCustomDBRole'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Custom Roles in One Project
      tags:
      - Custom Database Roles
    post:
      description: "Creates one custom role in the specified project. To use this\
        \ resource, the requesting API Key must have the Project Owner role."
      operationId: createCustomDatabaseRole
      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/UserCustomDBRole'
        description: Creates one custom role in the specified project.
        required: true
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserCustomDBRole'
              x-xgen-version: 2023-01-01
          description: Accepted
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Custom Role
      tags:
      - Custom Database Roles
  /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}:
    delete:
      description: "Removes one custom role from the specified project. You can't\
        \ remove a custom role that would leave one or more child roles with no parent\
        \ roles or actions. You also can't remove a custom role that would leave one\
        \ or more database users without roles. To use this resource, the requesting\
        \ API Key must have the Project Atlas Admin role."
      operationId: deleteCustomDatabaseRole
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the role for the request.
          This name must be unique for this custom role in this project.
        in: path
        name: roleName
        required: true
        schema:
          type: string
          pattern: "^\\b(?!xgen-)([0-9A-Za-z_\\-]+)\\b(?<!\\atlasAdmin|read|readWrite|dbAdmin|dbOwner|userAdmin|clusterAdmin|clusterManager|clusterMonitor|hostManager|backup|restore|readAnyDatabase|readWriteAnyDatabase|userAdminAnyDatabase|dbAdminAnyDatabase|root|__system)$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: No Content
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Custom Role from One Project
      tags:
      - Custom Database Roles
    get:
      description: "Returns one custom role for the specified project. To use this\
        \ resource, the requesting API Key must have the Project Read Only role."
      operationId: getCustomDatabaseRole
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the role for the request.
          This name must be unique for this custom role in this project.
        in: path
        name: roleName
        required: true
        schema:
          type: string
          pattern: "^\\b(?!xgen-)([0-9A-Za-z_\\-]+)\\b(?<!\\atlasAdmin|read|readWrite|dbAdmin|dbOwner|userAdmin|clusterAdmin|clusterManager|clusterMonitor|hostManager|backup|restore|readAnyDatabase|readWriteAnyDatabase|userAdminAnyDatabase|dbAdminAnyDatabase|root|__system)$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserCustomDBRole'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Custom Role in One Project
      tags:
      - Custom Database Roles
    patch:
      description: "Updates one custom role in the specified project. To use this\
        \ resource, the requesting API Key must have the Project Owner role."
      operationId: updateCustomDatabaseRole
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the role for the request.
          This name must beunique for this custom role in this project.
        in: path
        name: roleName
        required: true
        schema:
          type: string
          pattern: "^\\b(?!xgen-)([0-9A-Za-z_\\-]+)\\b(?<!\\atlasAdmin|read|readWrite|dbAdmin|dbOwner|userAdmin|clusterAdmin|clusterManager|clusterMonitor|hostManager|backup|restore|readAnyDatabase|readWriteAnyDatabase|userAdminAnyDatabase|dbAdminAnyDatabase|root|__system)$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/UpdateCustomDBRole'
        description: Updates one custom role in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserCustomDBRole'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Custom Role in One Project
      tags:
      - Custom Database Roles
  /api/atlas/v2/groups/{groupId}/dataFederation:
    get:
      description: "Returns the details of all federated database instances in the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Read Only or higher role."
      operationId: listFederatedDatabases
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Type of Federated Database Instances to return.
        in: query
        name: type
        schema:
          type: string
          default: USER
          enum:
          - USER
          - ONLINE_ARCHIVE
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataLakeTenant'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Federated Database Instances in One Project
      tags:
      - Data Federation
    post:
      description: "Creates one federated database instance in the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ or Project Charts Admin roles."
      operationId: createFederatedDatabase
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Flag that indicates whether this request should check if the
          requesting IAM role can read from the S3 bucket. AWS checks if the role
          can list the objects in the bucket before writing to it. Some IAM roles
          only need write permissions. This flag allows you to skip that check.
        in: query
        name: skipRoleValidation
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DataLakeTenant'
        description: Details to create one federated database instance in the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeTenant'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Federated Database Instance in One Project
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}:
    delete:
      description: "Removes one federated database instance from the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ or Project Charts Admin roles."
      operationId: deleteFederatedDatabase
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the federated database instance
          to remove.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Federated Database Instance from One Project
      tags:
      - Data Federation
    get:
      description: "Returns the details of one federated database instance within\
        \ the specified project. To use this resource, the requesting API Key must\
        \ have the Project Read Only or Project Charts Admin roles."
      operationId: getFederatedDatabase
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the Federated Database to
          return.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeTenant'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Federated Database Instance in One Project
      tags:
      - Data Federation
    patch:
      description: "Updates the details of one federated database instance in the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Owner or higher role."
      operationId: updateFederatedDatabase
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the federated database instance
          to update.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Flag that indicates whether this request should check if the
          requesting IAM role can read from the S3 bucket. AWS checks if the role
          can list the objects in the bucket before writing to it. Some IAM roles
          only need write permissions. This flag allows you to skip that check.
        in: query
        name: skipRoleValidation
        required: true
        schema:
          type: boolean
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DataLakeTenant'
        description: Details of one Federated Database to update in the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeTenant'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Federated Database Instance in One Project
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits:
    get:
      description: "Returns query limits for a federated databases instance in the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Read Only role."
      operationId: returnFederatedDatabaseQueryLimits
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the federated database instance
          for which you want to retrieve query limits.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataFederationTenantQueryLimit'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Query Limits for One Federated Database Instance
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}:
    delete:
      description: "Deletes one query limit for one federated database instance. To\
        \ use this resource, the requesting API Key must have the Project Owner role."
      operationId: deleteOneDataFederationInstanceQueryLimit
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the federated database instance
          to which the query limit applies.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: |
          Human-readable label that identifies this data federation instance limit.

          | Limit Name | Description | Default |
          | --- | --- | --- |
          | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |
          | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |
          | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |
          | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |
        in: path
        name: limitName
        required: true
        schema:
          type: string
          enum:
          - bytesProcessed.query
          - bytesProcessed.daily
          - bytesProcessed.weekly
          - bytesProcessed.monthly
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete One Query Limit For One Federated Database Instance
      tags:
      - Data Federation
    get:
      description: "Returns the details of one query limit for the specified federated\
        \ database instance in the specified project. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      operationId: returnFederatedDatabaseQueryLimit
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the federated database instance
          to which the query limit applies.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: |
          Human-readable label that identifies this data federation instance limit.

          | Limit Name | Description | Default |
          | --- | --- | --- |
          | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |
          | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |
          | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |
          | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |
        in: path
        name: limitName
        required: true
        schema:
          type: string
          enum:
          - bytesProcessed.query
          - bytesProcessed.daily
          - bytesProcessed.weekly
          - bytesProcessed.monthly
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataFederationTenantQueryLimit'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Federated Database Instance Query Limit for One Project
      tags:
      - Data Federation
    patch:
      description: "Creates or updates one query limit for one federated database\
        \ instance. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: createOneDataFederationQueryLimit
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the federated database instance
          to which the query limit applies.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: |
          Human-readable label that identifies this data federation instance limit.

          | Limit Name | Description | Default |
          | --- | --- | --- |
          | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |
          | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |
          | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |
          | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |
        in: path
        name: limitName
        required: true
        schema:
          type: string
          enum:
          - bytesProcessed.query
          - bytesProcessed.daily
          - bytesProcessed.weekly
          - bytesProcessed.monthly
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DataFederationTenantQueryLimit'
        description: Creates or updates one query limit for one federated database
          instance.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataFederationTenantQueryLimit'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Configure One Query Limit for One Federated Database Instance
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz:
    get:
      description: "Downloads the query logs for the specified federated database\
        \ instance. To use this resource, the requesting API Key must have the Project\
        \ Owner or Project Data Access Read Write roles."
      operationId: downloadFederatedDatabaseQueryLogs
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Timestamp that specifies the end point for the range of log messages
          to download.  MongoDB Cloud expresses this timestamp in the number of seconds
          that have elapsed since the UNIX epoch.
        in: query
        name: endDate
        schema:
          type: integer
          format: int64
          example: 1636481348
          pattern: "1199145600"
      - description: Timestamp that specifies the starting point for the range of
          log messages to download. MongoDB Cloud expresses this timestamp in the
          number of seconds that have elapsed since the UNIX epoch.
        in: query
        name: startDate
        schema:
          type: integer
          format: int64
          example: 1636466948
          pattern: "1199145600"
      - description: Human-readable label that identifies the federated database instance
          for which you want to download query logs.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+gzip:
              schema:
                type: string
                format: binary
                description: Compressed archive labeled `queryLogs.gz` downloads
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Download Query Logs for One Federated Database Instance
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/databaseUsers:
    get:
      description: "Returns all database users that belong to the specified project.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: listDatabaseUsers
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAtlasDatabaseUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Database Users from One Project
      tags:
      - Database Users
    post:
      description: "Creates one database user in the specified project. This MongoDB\
        \ Cloud supports a maximum of 100 database users per project. If you require\
        \ more than 100 database users on a project, contact [Support](https://cloud.mongodb.com/support).\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ or Project Charts Admin roles."
      operationId: createDatabaseUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            examples:
              AWS IAM Authentication:
                description: AWS IAM Authentication
                value:
                  awsIAMType: USER
                  databaseName: $external
                  groupId: 32b6e34b3d91647abb20e7b8
                  roles:
                  - databaseName: sales
                    roleName: readWrite
                  - databaseName: marketing
                    roleName: read
                  scopes:
                  - name: myCluster
                    type: CLUSTER
                  username: arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user
              Federated Authentication:
                description: Federated Authentication
                value:
                  databaseName: admin
                  groupId: 32b6e34b3d91647abb20e7b8
                  oidcAuthType: IDP_GROUP
                  roles:
                  - databaseName: sales
                    roleName: readWrite
                  - databaseName: marketing
                    roleName: read
                  scopes:
                  - name: myCluster
                    type: CLUSTER
                  username: 5dd7496c7a3e5a648454341c/sales
              LDAP Authentication:
                description: LDAP Authentication
                value:
                  databaseName: admin
                  groupId: 32b6e34b3d91647abb20e7b8
                  ldapAuthType: GROUP
                  roles:
                  - databaseName: sales
                    roleName: readWrite
                  - databaseName: marketing
                    roleName: read
                  scopes:
                  - name: myCluster
                    type: CLUSTER
                  username: "CN=marketing,OU=groups,DC=example,DC=com"
              SCRAM-SHA Authentication:
                description: SCRAM-SHA Authentication
                value:
                  databaseName: admin
                  groupId: 32b6e34b3d91647abb20e7b8
                  password: changeme123
                  roles:
                  - databaseName: sales
                    roleName: readWrite
                  - databaseName: marketing
                    roleName: read
                  scopes:
                  - name: myCluster
                    type: CLUSTER
                  username: david
              X509 Authentication:
                description: X509 Authentication
                value:
                  databaseName: $external
                  groupId: 32b6e34b3d91647abb20e7b8
                  roles:
                  - databaseName: sales
                    roleName: readWrite
                  - databaseName: marketing
                    roleName: read
                  scopes:
                  - name: myCluster
                    type: CLUSTER
                  username: "CN=david@example.com,OU=users,DC=example,DC=com"
                  x509Type: CUSTOMER
            schema:
              $ref: '#/components/schemas/CloudDatabaseUser'
        description: Creates one database user in the specified project.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudDatabaseUser'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Database User in One Project
      tags:
      - Database Users
  /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}:
    delete:
      description: "Removes one database user from the specified project. To use this\
        \ resource, the requesting API Key must have the Project Owner role."
      operationId: deleteDatabaseUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Human-readable label that identifies the database against which\
          \ the database user authenticates. Database users must provide both a username\
          \ and authentication database to log into MongoDB. If the user authenticates\
          \ with AWS IAM, x.509, or LDAP, this value should be `$external`. If the\
          \ user authenticates with SCRAM-SHA or OIDC, this value should be `admin`."
        in: path
        name: databaseName
        required: true
        schema:
          type: string
      - description: |
          Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

          | Authentication Method | Parameter Needed | Parameter Value | username Format |
          |---|---|---|---|
          | AWS IAM | awsType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr> |
          | AWS IAM | awsType | USER | <abbr title="Amazon Resource Name">ARN</abbr> |
          | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
          | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
        in: path
        name: username
        required: true
        schema:
          type: string
          example: "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs\
            \ or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM\
            \ or OIDC: IdPIdentifier/IdPGroupName"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Database User from One Project
      tags:
      - Database Users
    get:
      description: "Returns one database user that belong to the specified project.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: getDatabaseUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Human-readable label that identifies the database against which\
          \ the database user authenticates. Database users must provide both a username\
          \ and authentication database to log into MongoDB. If the user authenticates\
          \ with AWS IAM, x.509, or LDAP, this value should be `$external`. If the\
          \ user authenticates with SCRAM-SHA or OIDC, this value should be `admin`."
        in: path
        name: databaseName
        required: true
        schema:
          type: string
      - description: |
          Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

          | Authentication Method | Parameter Needed | Parameter Value | username Format |
          |---|---|---|---|
          | AWS IAM | awsType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr> |
          | AWS IAM | awsType | USER | <abbr title="Amazon Resource Name">ARN</abbr> |
          | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
          | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
        in: path
        name: username
        required: true
        schema:
          type: string
          example: "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs\
            \ or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM\
            \ or OIDC: IdPIdentifier/IdPGroupName"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudDatabaseUser'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Database User from One Project
      tags:
      - Database Users
    patch:
      description: "Updates one database user that belongs to the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ or Project Charts Admin roles."
      operationId: updateDatabaseUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Human-readable label that identifies the database against which\
          \ the database user authenticates. Database users must provide both a username\
          \ and authentication database to log into MongoDB. If the user authenticates\
          \ with AWS IAM, x.509, or LDAP, this value should be `$external`. If the\
          \ user authenticates with SCRAM-SHA or OIDC, this value should be `admin`."
        in: path
        name: databaseName
        required: true
        schema:
          type: string
      - description: |
          Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

          | Authentication Method | Parameter Needed | Parameter Value | username Format |
          |---|---|---|---|
          | AWS IAM | awsType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr> |
          | AWS IAM | awsType | USER | <abbr title="Amazon Resource Name">ARN</abbr> |
          | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
          | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
          | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
        in: path
        name: username
        required: true
        schema:
          type: string
          example: "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs\
            \ or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM\
            \ or OIDC: IdPIdentifier/IdPGroupName"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CloudDatabaseUser'
        description: Updates one database user that belongs to the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudDatabaseUser'
              x-xgen-version: 2023-01-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Database User in One Project
      tags:
      - Database Users
  /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs:
    get:
      description: "Returns all unexpired X.509 certificates for the specified MongoDB\
        \ user. This MongoDB user belongs to one project. Atlas manages these certificates\
        \ and the MongoDB user. To use this resource, the requesting API Key must\
        \ have the Project Read Only role."
      operationId: listDatabaseUserCertificates
      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: Human-readable label that represents the MongoDB database user
          account whose certificates you want to return.
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedUserCertView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All X.509 Certificates Assigned to One MongoDB User
      tags:
      - X.509 Authentication
    post:
      description: |-
        Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role.

        To get MongoDB Cloud to generate a managed certificate for a database user, set `"x509Type" : "MANAGED"` on the desired MongoDB Database User.

        If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.
      externalDocs:
        description: Self-Managed X.509
        url: https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509
      operationId: createDatabaseUserCertificate
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that represents the MongoDB database user
          account for whom to create a certificate.
        in: path
        name: username
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/UserCert'
        description: Generates one X.509 certificate for the specified MongoDB user.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: string
                description: PEM file that contains the user's X.509 certificate and
                  private key.
              x-xgen-version: 2023-01-01
          description: This endpoint returns a PEM file with the certificate and private
            key.
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One X.509 Certificate for One MongoDB User
      tags:
      - X.509 Authentication
  /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}:
    get:
      description: "Returns the access logs of one cluster identified by the cluster's\
        \ name. Access logs contain a list of authentication requests made against\
        \ your cluster. You can't use this feature on tenant-tier clusters (M0, M2,\
        \ M5). To use this resource, the requesting API Key must have the Project\
        \ Monitoring Admin role."
      externalDocs:
        description: Database Access History
        url: https://docs.atlas.mongodb.com/access-tracking/
      operationId: listAccessLogsByClusterName
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Flag that indicates whether the response returns the successful
          authentication attempts only.
        in: query
        name: authResult
        schema:
          type: boolean
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: "Date and time when to stop retrieving database history. If you\
          \ specify **end**, you must also specify **start**. This parameter uses\
          \ UNIX epoch time in milliseconds."
        in: query
        name: end
        schema:
          type: integer
          format: int64
      - description: One Internet Protocol address that attempted to authenticate
          with the database.
        in: query
        name: ipAddress
        schema:
          type: string
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
      - description: Maximum number of lines from the log to return.
        in: query
        name: nLogs
        schema:
          type: integer
          format: int32
          default: 20000
          maximum: 20000
          minimum: 0
      - description: "Date and time when MongoDB Cloud begins retrieving database\
          \ history. If you specify **start**, you must also specify **end**. This\
          \ parameter uses UNIX epoch time in milliseconds."
        in: query
        name: start
        schema:
          type: integer
          format: int64
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MongoDBAccessLogsList'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Database Access History for One Cluster using Its Cluster Name
      tags:
      - Access Tracking
  /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}:
    get:
      description: "Returns the access logs of one cluster identified by the cluster's\
        \ hostname. Access logs contain a list of authentication requests made against\
        \ your clusters. You can't use this feature on tenant-tier clusters (M0, M2,\
        \ M5). To use this resource, the requesting API Key must have the Project\
        \ Monitoring Admin role."
      externalDocs:
        description: Database Access History
        url: https://docs.atlas.mongodb.com/access-tracking/
      operationId: listAccessLogsByHostname
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Flag that indicates whether the response returns the successful
          authentication attempts only.
        in: query
        name: authResult
        schema:
          type: boolean
      - description: "Date and time when to stop retrieving database history. If you\
          \ specify **end**, you must also specify **start**. This parameter uses\
          \ UNIX epoch time in milliseconds."
        in: query
        name: end
        schema:
          type: integer
          format: int64
      - description: Fully qualified domain name or IP address of the MongoDB host
          that stores the log files that you want to download.
        in: path
        name: hostname
        required: true
        schema:
          type: string
      - description: One Internet Protocol address that attempted to authenticate
          with the database.
        in: query
        name: ipAddress
        schema:
          type: string
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
      - description: Maximum number of lines from the log to return.
        in: query
        name: nLogs
        schema:
          type: integer
          format: int32
          default: 20000
          maximum: 20000
          minimum: 0
      - description: "Date and time when MongoDB Cloud begins retrieving database\
          \ history. If you specify **start**, you must also specify **end**. This\
          \ parameter uses UNIX epoch time in milliseconds."
        in: query
        name: start
        schema:
          type: integer
          format: int64
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MongoDBAccessLogsList'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Database Access History for One Cluster using Its Hostname
      tags:
      - Access Tracking
  /api/atlas/v2/groups/{groupId}/encryptionAtRest:
    get:
      description: |-
        Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role.

        **LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.
      operationId: getEncryptionAtRest
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/EncryptionAtRest'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Configuration for Encryption at Rest using Customer-Managed
        Keys for One Project
      tags:
      - Encryption at Rest using Customer Key Management
    patch:
      description: |-
        Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters.

         After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.
      operationId: updateEncryptionAtRest
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/EncryptionAtRest'
        description: |-
          Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:

          If you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.

          - To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.
          - To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.
          - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.

          If you enabled Encryption at Rest using Customer Key  Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/EncryptionAtRest'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Configuration for Encryption at Rest using Customer-Managed
        Keys for One Project
      tags:
      - Encryption at Rest using Customer Key Management
  /api/atlas/v2/groups/{groupId}/events:
    get:
      description: |-
        Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listProjectEvents
      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: Human-readable label that identifies the cluster.
        in: query
        name: clusterNames
        schema:
          type: array
          items:
            type: string
            maxLength: 64
            minLength: 1
            pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
        style: form
      - description: |-
          Category of incident recorded at this moment in time.

          **IMPORTANT**: The complete list of event type values changes frequently.
        in: query
        name: eventType
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EventTypeForNdsGroup'
      - description: |-
          Category of event that you would like to exclude from query results, such as CLUSTER_CREATED

          **IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.
        in: query
        name: excludedEventType
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EventTypeForNdsGroup'
      - description: Flag that indicates whether to include the raw document in the
          output. The raw document contains additional meta information about the
          event.
        in: query
        name: includeRaw
        schema:
          type: boolean
          default: false
      - description: Date and time from when MongoDB Cloud stops returning events.
          This parameter uses the <a href="https://en.wikipedia.org/wiki/ISO_8601"
          target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
          in UTC.
        in: query
        name: maxDate
        schema:
          type: string
          format: date-time
      - description: Date and time from when MongoDB Cloud starts returning events.
          This parameter uses the <a href="https://en.wikipedia.org/wiki/ISO_8601"
          target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
          in UTC.
        in: query
        name: minDate
        schema:
          type: string
          format: date-time
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupPaginatedEventView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Events from One Project
      tags:
      - Events
  /api/atlas/v2/groups/{groupId}/events/{eventId}:
    get:
      description: |-
        Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: getProjectEvent
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the event\
          \ that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents)\
          \ endpoint to retrieve all events to which the authenticated user has access."
        in: path
        name: eventId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Flag that indicates whether to include the raw document in the
          output. The raw document contains additional meta information about the
          event.
        in: query
        name: includeRaw
        schema:
          type: boolean
          default: false
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/EventViewForNdsGroup'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Event from One Project
      tags:
      - Events
  /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics:
    get:
      description: Returns all Atlas Search metric types available for one process
        in the specified project. You must have the Project Read Only or higher role
        to view the Atlas Search metric types.
      operationId: listMetricTypes
      parameters:
      - $ref: '#/components/parameters/processId'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudSearchMetrics'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Atlas Search Metric Types for One Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements:
    get:
      description: Returns the Atlas Search index metrics within the specified time
        range for one namespace in the specified process.
      operationId: listIndexMetrics
      parameters:
      - $ref: '#/components/parameters/processId'
      - $ref: '#/components/parameters/databaseName'
      - $ref: '#/components/parameters/collectionName'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/granularity'
      - $ref: '#/components/parameters/period'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/envelope'
      - description: List that contains the measurements that MongoDB Atlas reports
          for the associated data series.
        in: query
        name: metrics
        required: true
        schema:
          type: array
          description: List that contains the measurements that MongoDB Atlas reports
            for the associated data series.
          items:
            type: string
            enum:
            - INDEX_SIZE_ON_DISK
            - NUMBER_OF_DELETES
            - NUMBER_OF_ERROR_QUERIES
            - NUMBER_OF_GETMORE_COMMANDS
            - NUMBER_OF_INDEX_FIELDS
            - NUMBER_OF_INSERTS
            - NUMBER_OF_SUCCESS_QUERIES
            - NUMBER_OF_UPDATES
            - REPLICATION_LAG
            - TOTAL_NUMBER_OF_QUERIES
          maxItems: 10
          uniqueItems: true
        style: form
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MeasurementsIndexes'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Atlas Search Index Metrics for One Namespace
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements:
    get:
      description: Returns the Atlas Search metrics data series within the provided
        time range for one namespace and index name on the specified process. You
        must have the Project Read Only or higher role to view the Atlas Search metric
        types.
      operationId: getIndexMetrics
      parameters:
      - $ref: '#/components/parameters/processId'
      - $ref: '#/components/parameters/indexName'
      - $ref: '#/components/parameters/databaseName'
      - $ref: '#/components/parameters/collectionName'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/granularity'
      - $ref: '#/components/parameters/period'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/envelope'
      - description: List that contains the measurements that MongoDB Atlas reports
          for the associated data series.
        in: query
        name: metrics
        required: true
        schema:
          type: array
          description: List that contains the measurements that MongoDB Atlas reports
            for the associated data series.
          items:
            type: string
            enum:
            - INDEX_SIZE_ON_DISK
            - NUMBER_OF_DELETES
            - NUMBER_OF_ERROR_QUERIES
            - NUMBER_OF_GETMORE_COMMANDS
            - NUMBER_OF_INDEX_FIELDS
            - NUMBER_OF_INSERTS
            - NUMBER_OF_SUCCESS_QUERIES
            - NUMBER_OF_UPDATES
            - REPLICATION_LAG
            - TOTAL_NUMBER_OF_QUERIES
          maxItems: 10
          uniqueItems: true
        style: form
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MeasurementsIndexes'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Atlas Search Metrics for One Index in One Specified Namespace
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements:
    get:
      description: Returns the Atlas Search hardware and status data series within
        the provided time range for one process in the specified project. You must
        have the Project Read Only or higher role to view the Atlas Search metric
        types.
      operationId: getMeasurements
      parameters:
      - $ref: '#/components/parameters/processId'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/granularity'
      - $ref: '#/components/parameters/period'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/envelope'
      - description: "List that contains the metrics that you want MongoDB Atlas to\
          \ report for the associated data series. If you don't set this parameter,\
          \ this resource returns all hardware and status metrics for the associated\
          \ data series."
        in: query
        name: metrics
        required: true
        schema:
          type: array
          description: "List that contains the metrics that you want MongoDB Atlas\
            \ to report for the associated data series. If you don't set this parameter,\
            \ this resource returns all hardware and status metrics for the associated\
            \ data series."
          items:
            type: string
            enum:
            - FTS_DISK_USAGE
            - FTS_PROCESS_CPU_KERNEL
            - FTS_PROCESS_CPU_USER
            - FTS_PROCESS_NORMALIZED_CPU_KERNEL
            - FTS_PROCESS_NORMALIZED_CPU_USER
            - FTS_PROCESS_RESIDENT_MEMORY
            - FTS_PROCESS_SHARED_MEMORY
            - FTS_PROCESS_VIRTUAL_MEMORY
            - JVM_CURRENT_MEMORY
            - JVM_MAX_MEMORY
            - PAGE_FAULTS
          maxItems: 10
          uniqueItems: true
        style: form
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MeasurementsNonIndex'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Atlas Search Hardware and Status Metrics
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/integrations:
    get:
      description: "Returns the settings that permit integrations with all configured\
        \ third-party services. These settings apply to all databases managed in one\
        \ MongoDB Cloud project. To use this resource, the requesting API Key must\
        \ have the Organization Owner or Project Owner role."
      operationId: listThirdPartyIntegrations
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedIntegrationView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Active Third-Party Service Integrations
      tags:
      - Third-Party Integrations
  /api/atlas/v2/groups/{groupId}/integrations/{integrationType}:
    delete:
      description: "Removes the settings that permit configuring one third-party service\
        \ integration. These settings apply to all databases managed in one MongoDB\
        \ Cloud project. If you delete an integration from a project, you remove that\
        \ integration configuration only for that project. This action doesn't affect\
        \ any other project or organization's configured `{INTEGRATION-TYPE}` integrations.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Owner or Project Owner role."
      operationId: deleteThirdPartyIntegration
      parameters:
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          type: string
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Third-Party Service Integration
      tags:
      - Third-Party Integrations
    get:
      description: "Returns the settings for configuring integration with one third-party\
        \ service. These settings apply to all databases managed in one MongoDB Cloud\
        \ project. To use this resource, the requesting API Key must have the Organization\
        \ Owner or Project Owner role."
      operationId: getThirdPartyIntegration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          type: string
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ThirdPartyIntegration'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Third-Party Service Integration
      tags:
      - Third-Party Integrations
    post:
      description: "Adds the settings for configuring one third-party service integration.\
        \ These settings apply to all databases managed in the specified MongoDB Cloud\
        \ project. Each project can have only one configuration per `{INTEGRATION-TYPE}`.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Owner or Project Owner role."
      operationId: createThirdPartyIntegration
      parameters:
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          type: string
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ThirdPartyIntegration'
        description: Third-party integration that you want to configure for your project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedIntegrationView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Configure One Third-Party Service Integration
      tags:
      - Third-Party Integrations
    put:
      description: "Updates the settings for configuring integration with one third-party\
        \ service. These settings apply to all databases managed in one MongoDB Cloud\
        \ project. To use this resource, the requesting API Key must have the Organization\
        \ Owner or Project Owner role."
      operationId: updateThirdPartyIntegration
      parameters:
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          type: string
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ThirdPartyIntegration'
        description: Third-party integration that you want to configure for your project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedIntegrationView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Third-Party Service Integration
      tags:
      - Third-Party Integrations
  /api/atlas/v2/groups/{groupId}/invites:
    get:
      deprecated: true
      description: "Returns all pending invitations to the specified project. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: listProjectInvitations
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Email address of the user account invited to this project.
        in: query
        name: username
        schema:
          type: string
          format: email
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Project Invitations
      tags:
      - Projects
      x-sunset: 2024-10-04
    patch:
      deprecated: true
      description: "Updates the details of one pending invitation to the specified\
        \ project. To specify which invitation to update, provide the username of\
        \ the invited user. To use this resource, the requesting API Key must have\
        \ the Project Owner role."
      operationId: updateProjectInvitation
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/GroupInvitationRequest'
        description: Updates the details of one pending invitation to the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Project Invitation
      tags:
      - Projects
      x-sunset: 2024-10-04
    post:
      deprecated: true
      description: "Invites one MongoDB Cloud user to join the specified project.\
        \ The MongoDB Cloud user must accept the invitation to access information\
        \ within the specified project. To use this resource, the requesting API Key\
        \ must have the Project Owner role."
      operationId: createProjectInvitation
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/GroupInvitationRequest'
        description: Invites one MongoDB Cloud user to join the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Invite One MongoDB Cloud User to Join One Project
      tags:
      - Projects
      x-sunset: 2024-10-04
  /api/atlas/v2/groups/{groupId}/invites/{invitationId}:
    delete:
      deprecated: true
      description: "Cancels one pending invitation sent to the specified MongoDB Cloud\
        \ user to join a project. You can't cancel an invitation that the user accepted.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      operationId: deleteProjectInvitation
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 24-hexadecimal digit string that identifies the invitation.
        in: path
        name: invitationId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Cancel One Project Invitation
      tags:
      - Projects
      x-sunset: 2024-10-04
    get:
      deprecated: true
      description: "Returns the details of one pending invitation to the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: getProjectInvitation
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the invitation.
        in: path
        name: invitationId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Project Invitation
      tags:
      - Projects
      x-sunset: 2024-10-04
    patch:
      deprecated: true
      description: "Updates the details of one pending invitation to the specified\
        \ project. To specify which invitation to update, provide the unique identification\
        \ string for that invitation. Use the Return All Project Invitations endpoint\
        \ to retrieve IDs for all pending project invitations. To use this resource,\
        \ the requesting API Key must have the Project Owner role."
      operationId: updateProjectInvitationById
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 24-hexadecimal digit string that identifies the invitation.
        in: path
        name: invitationId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/GroupInvitationUpdateRequest'
        description: Updates the details of one pending invitation to the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Project Invitation by Invitation ID
      tags:
      - Projects
      x-sunset: 2024-10-04
  /api/atlas/v2/groups/{groupId}/ipAddresses:
    get:
      description: "Returns all IP addresses for this project. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: returnAllIPAddresses
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupIPAddresses'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All IP Addresses for One Project
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/limits:
    get:
      description: "Returns all the limits for the specified project. To use this\
        \ resource, the requesting API Key must have the Project Read Only role."
      operationId: listProjectLimits
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataFederationLimit'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Limits for One Project
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/limits/{limitName}:
    delete:
      description: "Removes the specified project limit. Depending on the limit, Atlas\
        \ either resets the limit to its default value or removes the limit entirely.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      operationId: deleteProjectLimit
      parameters:
      - description: |
          Human-readable label that identifies this project limit.

          | Limit Name | Description | Default | API Override Limit |
          | --- | --- | --- | --- |
          | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |
          | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |
          | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |
          | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |
          | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |
          | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |
          | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |
          | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |
          | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |
          | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |
          | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Serivce Connections per Region Group | 50 | 100|
          | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|
        in: path
        name: limitName
        required: true
        schema:
          type: string
          enum:
          - atlas.project.security.databaseAccess.users
          - atlas.project.deployment.clusters
          - atlas.project.deployment.serverlessMTMs
          - atlas.project.security.databaseAccess.customRoles
          - atlas.project.security.networkAccess.entries
          - atlas.project.security.networkAccess.crossRegionEntries
          - atlas.project.deployment.nodesPerPrivateLinkRegion
          - dataFederation.bytesProcessed.query
          - dataFederation.bytesProcessed.daily
          - dataFederation.bytesProcessed.weekly
          - dataFederation.bytesProcessed.monthly
          - atlas.project.deployment.privateServiceConnectionsPerRegionGroup
          - atlas.project.deployment.privateServiceConnectionsSubnetMask
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Project Limit
      tags:
      - Projects
    get:
      description: "Returns the specified limit for the specified project. To use\
        \ this resource, the requesting API Key must have the Project Read Only role."
      operationId: getProjectLimit
      parameters:
      - description: |
          Human-readable label that identifies this project limit.

          | Limit Name | Description | Default | API Override Limit |
          | --- | --- | --- | --- |
          | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |
          | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |
          | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |
          | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |
          | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |
          | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |
          | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |
          | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |
          | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |
          | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |
          | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Serivce Connections per Region Group | 50 | 100|
          | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|
        in: path
        name: limitName
        required: true
        schema:
          type: string
          enum:
          - atlas.project.security.databaseAccess.users
          - atlas.project.deployment.clusters
          - atlas.project.deployment.serverlessMTMs
          - atlas.project.security.databaseAccess.customRoles
          - atlas.project.security.networkAccess.entries
          - atlas.project.security.networkAccess.crossRegionEntries
          - atlas.project.deployment.nodesPerPrivateLinkRegion
          - dataFederation.bytesProcessed.query
          - dataFederation.bytesProcessed.daily
          - dataFederation.bytesProcessed.weekly
          - dataFederation.bytesProcessed.monthly
          - atlas.project.deployment.privateServiceConnectionsPerRegionGroup
          - atlas.project.deployment.privateServiceConnectionsSubnetMask
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataFederationLimit'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Limit for One Project
      tags:
      - Projects
    patch:
      description: |-
        Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.

        **NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.
      operationId: setProjectLimit
      parameters:
      - description: |
          Human-readable label that identifies this project limit.

          | Limit Name | Description | Default | API Override Limit |
          | --- | --- | --- | --- |
          | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |
          | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |
          | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |
          | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |
          | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |
          | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |
          | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |
          | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |
          | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |
          | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |
          | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Serivce Connections per Region Group | 50 | 100|
          | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|
        in: path
        name: limitName
        required: true
        schema:
          type: string
          enum:
          - atlas.project.security.databaseAccess.users
          - atlas.project.deployment.clusters
          - atlas.project.deployment.serverlessMTMs
          - atlas.project.security.databaseAccess.customRoles
          - atlas.project.security.networkAccess.entries
          - atlas.project.security.networkAccess.crossRegionEntries
          - atlas.project.deployment.nodesPerPrivateLinkRegion
          - dataFederation.bytesProcessed.query
          - dataFederation.bytesProcessed.daily
          - dataFederation.bytesProcessed.weekly
          - dataFederation.bytesProcessed.monthly
          - atlas.project.deployment.privateServiceConnectionsPerRegionGroup
          - atlas.project.deployment.privateServiceConnectionsSubnetMask
      - $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/DataFederationLimit'
        description: Limit to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataFederationLimit'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Set One Project Limit
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/liveMigrations:
    post:
      description: |-
        Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.

         Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.

         You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.

         **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.
      operationId: createPushMigration
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/LiveMigrationRequest'
        description: One migration to be created.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/LiveMigrationResponse'
              x-xgen-version: 2023-01-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Migrate One Local Managed Cluster to MongoDB Atlas
      tags:
      - Cloud Migration Service
  /api/atlas/v2/groups/{groupId}/liveMigrations/validate:
    post:
      description: "Verifies whether the provided credentials, available disk space,\
        \ MongoDB versions, and so on meet the requirements of the migration request.\
        \ If the check passes, the migration can proceed. Your API Key must have the\
        \ Organization Owner role to successfully call this resource."
      operationId: validateMigration
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/LiveMigrationRequest'
        description: One migration to be validated.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/LiveImportValidation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Validate One Migration Request
      tags:
      - Cloud Migration Service
  /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}:
    get:
      description: Return the status of one migration validation job. Your API Key
        must have the Organization Owner role to successfully call this resource.
      operationId: getValidationStatus
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Unique 24-hexadecimal digit string that identifies the validation
          job.
        in: path
        name: validationId
        required: true
        schema:
          type: string
          example: 507f1f77bcf86cd799439011
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/LiveImportValidation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Migration Validation Job
      tags:
      - Cloud Migration Service
  /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}:
    get:
      description: Return details of one cluster migration job. Each push live migration
        job uses one migration host. Your API Key must have the Organization Member
        role to successfully call this resource.
      operationId: getPushMigration
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/liveMigrationId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/LiveMigrationResponse'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Migration Job
      tags:
      - Cloud Migration Service
  /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover:
    put:
      description: "Cut over the migrated cluster to MongoDB Atlas. Confirm when the\
        \ cut over completes. When the cut over completes, MongoDB Atlas completes\
        \ the live migration process and stops synchronizing with the source cluster.\
        \ Your API Key must have the Organization Owner role to successfully call\
        \ this resource."
      operationId: cutoverMigration
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/liveMigrationId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: Accepted.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Cut Over the Migrated Cluster
      tags:
      - Cloud Migration Service
  /api/atlas/v2/groups/{groupId}/maintenanceWindow:
    delete:
      description: "Resets the maintenance window for the specified project. To use\
        \ this resource, the requesting API Key must have the Project Owner role.\
        \ Urgent maintenance activities such as security patches can't wait for your\
        \ chosen window. MongoDB Cloud starts those maintenance activities when needed.\
        \ After you schedule maintenance for your cluster, you can't change your maintenance\
        \ window until the current maintenance efforts complete. The maintenance procedure\
        \ that MongoDB Cloud performs requires at least one replica set election during\
        \ the maintenance window per replica set. Maintenance always begins as close\
        \ to the scheduled hour as possible, but in-progress cluster updates or unexpected\
        \ system issues could delay the start time. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: resetMaintenanceWindow
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Reset One Maintenance Window for One Project
      tags:
      - Maintenance Windows
    get:
      description: "Returns the maintenance window for the specified project. MongoDB\
        \ Cloud starts those maintenance activities when needed. You can't change\
        \ your maintenance window until the current maintenance efforts complete.\
        \ The maintenance procedure that MongoDB Cloud performs requires at least\
        \ one replica set election during the maintenance window per replica set.\
        \ Maintenance always begins as close to the scheduled hour as possible, but\
        \ in-progress cluster updates or unexpected system issues could delay the\
        \ start time. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: getMaintenanceWindow
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupMaintenanceWindow'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Maintenance Window for One Project
      tags:
      - Maintenance Windows
    patch:
      description: "Updates the maintenance window for the specified project. Urgent\
        \ maintenance activities such as security patches can't wait for your chosen\
        \ window. MongoDB Cloud starts those maintenance activities when needed. After\
        \ you schedule maintenance for your cluster, you can't change your maintenance\
        \ window until the current maintenance efforts complete. The maintenance procedure\
        \ that MongoDB Cloud performs requires at least one replica set election during\
        \ the maintenance window per replica set. Maintenance always begins as close\
        \ to the scheduled hour as possible, but in-progress cluster updates or unexpected\
        \ system issues could delay the start time. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: updateMaintenanceWindow
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/GroupMaintenanceWindow'
        description: Updates the maintenance window for the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Maintenance Window for One Project
      tags:
      - Maintenance Windows
  /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer:
    post:
      description: "Toggles automatic deferral of the maintenance window for the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: toggleMaintenanceAutoDefer
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Toggle Automatic Deferral of Maintenance for One Project
      tags:
      - Maintenance Windows
  /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer:
    post:
      description: "Defers the maintenance window for the specified project. Urgent\
        \ maintenance activities such as security patches can't wait for your chosen\
        \ window. MongoDB Cloud starts those maintenance activities when needed. After\
        \ you schedule maintenance for your cluster, you can't change your maintenance\
        \ window until the current maintenance efforts complete. The maintenance procedure\
        \ that MongoDB Cloud performs requires at least one replica set election during\
        \ the maintenance window per replica set. Maintenance always begins as close\
        \ to the scheduled hour as possible, but in-progress cluster updates or unexpected\
        \ system issues could delay the start time. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: deferMaintenanceWindow
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Defer One Maintenance Window for One Project
      tags:
      - Maintenance Windows
  /api/atlas/v2/groups/{groupId}/managedSlowMs/disable:
    delete:
      description: "Disables the slow operation threshold that MongoDB Cloud calculated\
        \ for the specified project. The threshold determines which operations the\
        \ Performance Advisor and Query Profiler considers slow. When enabled, MongoDB\
        \ Cloud uses the average execution time for operations on your cluster to\
        \ determine slow-running queries. As a result, the threshold is more pertinent\
        \ to your cluster workload. The slow operation threshold is enabled by default\
        \ for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any\
        \ operation that takes longer than 100 milliseconds to be slow. To use this\
        \ resource, the requesting API Key must have the Project Owner role."
      operationId: disableSlowOperationThresholding
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Disable Managed Slow Operation Threshold
      tags:
      - Performance Advisor
  /api/atlas/v2/groups/{groupId}/managedSlowMs/enable:
    post:
      description: "Enables MongoDB Cloud to use its slow operation threshold for\
        \ the specified project. The threshold determines which operations the Performance\
        \ Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses\
        \ the average execution time for operations on your cluster to determine slow-running\
        \ queries. As a result, the threshold is more pertinent to your cluster workload.\
        \ The slow operation threshold is enabled by default for dedicated clusters\
        \ (M10+). When disabled, MongoDB Cloud considers any operation that takes\
        \ longer than 100 milliseconds to be slow. To use this resource, the requesting\
        \ API Key must have the Project Owner role."
      operationId: enableSlowOperationThresholding
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Enable Managed Slow Operation Threshold
      tags:
      - Performance Advisor
  /api/atlas/v2/groups/{groupId}/peers:
    get:
      description: "Returns details about all network peering connections in the specified\
        \ project. Network peering allows multiple cloud-hosted applications to securely\
        \ connect to the same project. To use this resource, the requesting API Key\
        \ must have the Project Read Only role."
      operationId: listPeeringConnections
      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 service provider to use for this VPC peering connection.
        in: query
        name: providerName
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedContainerPeerView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Network Peering Connections in One Project
      tags:
      - Network Peering
    post:
      description: "Creates one new network peering connection in the specified project.\
        \ Network peering allows multiple cloud-hosted applications to securely connect\
        \ to the same project. To use this resource, the requesting API Key must have\
        \ the Project Owner role. To learn more about considerations and prerequisites,\
        \ see the Network Peering Documentation."
      externalDocs:
        description: Azure Network Peering Prerequisites
        url: https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites
      operationId: createPeeringConnection
      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/BaseNetworkPeeringConnectionSettings'
        description: Create one network peering connection.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BaseNetworkPeeringConnectionSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One New Network Peering Connection
      tags:
      - Network Peering
  /api/atlas/v2/groups/{groupId}/peers/{peerId}:
    delete:
      description: "Removes one network peering connection in the specified project.\
        \ If you Removes the last network peering connection associated with a project,\
        \ MongoDB Cloud also removes any AWS security groups from the project IP access\
        \ list. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: deletePeeringConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the network
          peering connection that you want to delete.
        in: path
        name: peerId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/RequestAccepted'
              x-xgen-version: 2023-01-01
          description: Accepted
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Existing Network Peering Connection
      tags:
      - Network Peering
    get:
      description: "Returns details about one specified network peering connection\
        \ in the specified project. To use this resource, the requesting API Key must\
        \ have the Project Read Only role."
      operationId: getPeeringConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the network
          peering connection that you want to retrieve.
        in: path
        name: peerId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BaseNetworkPeeringConnectionSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Network Peering Connection in One Project
      tags:
      - Network Peering
    patch:
      description: "Updates one specified network peering connection in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: updatePeeringConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the network
          peering connection that you want to update.
        in: path
        name: peerId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/BaseNetworkPeeringConnectionSettings'
        description: Modify one network peering connection.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BaseNetworkPeeringConnectionSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One New Network Peering Connection
      tags:
      - Network Peering
  /api/atlas/v2/groups/{groupId}/pipelines:
    get:
      description: "Returns a list of Data Lake Pipelines. To use this resource, the\
        \ requesting API Key must have the Project Read Only role."
      operationId: listPipelines
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataLakeIngestionPipeline'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Data Lake Pipelines from One Project
      tags:
      - Data Lake Pipelines
    post:
      description: Creates one Data Lake Pipeline.
      operationId: createPipeline
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DataLakeIngestionPipeline'
        description: Creates one Data Lake Pipeline.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeIngestionPipeline'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}:
    delete:
      description: Removes one Data Lake Pipeline.
      operationId: deletePipeline
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
    get:
      description: "Returns the details of one Data Lake Pipeline within the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getPipeline
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeIngestionPipeline'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
    patch:
      description: Updates one Data Lake Pipeline.
      operationId: updatePipeline
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/DataLakeIngestionPipeline'
        description: Updates one Data Lake Pipeline.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeIngestionPipeline'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules:
    get:
      description: "Returns a list of backup schedule policy items that you can use\
        \ as a Data Lake Pipeline source. To use this resource, the requesting API\
        \ Key must have the Project Read Only role."
      operationId: listPipelineSchedules
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DiskBackupApiPolicyItem'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Available Ingestion Schedules for One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots:
    get:
      description: "Returns a list of backup snapshots that you can use to trigger\
        \ an on demand pipeline run. To use this resource, the requesting API Key\
        \ must have the Project Read Only role."
      operationId: listPipelineSnapshots
      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: "Date and time after which MongoDB Cloud created the snapshot.\
          \ If specified, MongoDB Cloud returns available backup snapshots created\
          \ after this time and date only. This parameter expresses its value in the\
          \ ISO 8601 timestamp format in UTC."
        in: query
        name: completedAfter
        schema:
          type: string
          format: date-time
          example: 2022-01-01T00:00:00Z
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedBackupSnapshotView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Available Backup Snapshots for One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause:
    post:
      description: "Pauses ingestion for a Data Lake Pipeline within the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: pausePipeline
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeIngestionPipeline'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Pause One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume:
    post:
      description: "Resumes ingestion for a Data Lake Pipeline within the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: resumePipeline
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/DataLakeIngestionPipeline'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Resume One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs:
    get:
      description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: listPipelineRuns
      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: "If specified, Atlas returns only Data Lake Pipeline runs initiated\
          \ before this time and date."
        in: query
        name: createdBefore
        schema:
          type: string
          format: date-time
          example: 2022-01-01T00:00:00Z
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedPipelineRunView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Data Lake Pipeline Runs from One Project
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}:
    delete:
      description: Deletes dataset that Atlas generated during the specified pipeline
        run.
      operationId: deletePipelineRunDataset
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      - description: Unique 24-hexadecimal character string that identifies a Data
          Lake Pipeline run.
        in: path
        name: pipelineRunId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/RequestAccepted'
              x-xgen-version: 2023-01-01
          description: Accepted
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete Pipeline Run Dataset
      tags:
      - Data Lake Pipelines
    get:
      description: "Returns the details of one Data Lake Pipeline run within the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getPipelineRun
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      - description: Unique 24-hexadecimal character string that identifies a Data
          Lake Pipeline run.
        in: path
        name: pipelineRunId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/IngestionPipelineRun'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Data Lake Pipeline Run
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger:
    post:
      description: Triggers a Data Lake Pipeline ingestion of a specified snapshot.
      operationId: triggerSnapshotIngestion
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[^/\\\\ \"$]{1,64}$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/TriggerIngestionPipelineRequest'
        description: Triggers a single ingestion run of a snapshot.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/IngestionPipelineRun'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Trigger on demand snapshot ingestion
      tags:
      - Data Lake Pipelines
  /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService:
    post:
      description: "Creates one private endpoint service for the specified cloud service\
        \ provider. This cloud service provider manages the private endpoint service\
        \ for the project. When you create a private endpoint service, MongoDB Cloud\
        \ creates a network container in the project for the cloud provider for which\
        \ you create the private endpoint service if one doesn't already exist. To\
        \ learn more about private endpoint terminology in MongoDB Cloud, see Private\
        \ Endpoint Concepts. To use this resource, the requesting API Key must have\
        \ the Project Owner role."
      externalDocs:
        description: Private Endpoint Concepts
        url: https://dochub.mongodb.org/core/private-endpoint-concepts
      operationId: createPrivateEndpointService
      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/CloudProviderEndpointServiceRequest'
        description: Creates one private endpoint for the specified cloud service
          provider.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/EndpointService'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
  /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode:
    get:
      description: "Checks whether each region in the specified cloud service provider\
        \ can create multiple private endpoints per region. The cloud service provider\
        \ manages the private endpoint for the project. To use this resource, the\
        \ requesting API Key must have the Project Read Only role."
      operationId: getRegionalizedPrivateEndpointSetting
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ProjectSettingItemView'
              x-xgen-version: 2023-01-01
          description: OK
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Regionalized Private Endpoint Status
      tags:
      - Private Endpoint Services
    patch:
      description: "Enables or disables the ability to create multiple private endpoints\
        \ per region in all cloud service providers in one project. The cloud service\
        \ provider manages the private endpoints for the project. Connection strings\
        \ to existing multi-region and global sharded clusters change when you enable\
        \ this setting. You must update your applications to use the new connection\
        \ strings. This might cause downtime. To use this resource, the requesting\
        \ API Key must have the Project Owner role and all clusters in the deployment\
        \ must be sharded clusters. Once enabled, you cannot create replica sets."
      operationId: toggleRegionalizedPrivateEndpointSetting
      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/ProjectSettingItemView'
        description: Enables or disables the ability to create multiple private endpoints
          per region in all cloud service providers in one project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ProjectSettingItemView'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Toggle Regionalized Private Endpoint Status
      tags:
      - Private Endpoint Services
  /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint:
    get:
      description: Returns all private endpoints for one serverless instance. You
        must have at least the Project Read Only role for the project to successfully
        call this resource.
      operationId: listServerlessPrivateEndpoints
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance
          associated with the tenant endpoint.
        in: path
        name: instanceName
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServerlessTenantEndpoint'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Private Endpoints for One Serverless Instance
      tags:
      - Serverless Private Endpoints
    post:
      description: |-
        Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.

         A new endpoint won't be immediately available after creation.  Read the steps in the linked tutorial for detailed guidance.
      externalDocs:
        description: Set Up a Private Endpoint for a Serverless Instance Tutorial
        url: https://dochub.mongodb.org/core/serverless-private-endpoint
      operationId: createServerlessPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance
          for which the tenant endpoint will be created.
        in: path
        name: instanceName
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ServerlessTenantCreateRequest'
        description: Information about the Private Endpoint to create for the Serverless
          Instance.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessTenantEndpoint'
              x-xgen-version: 2023-01-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
  /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}:
    delete:
      description: "Remove one private endpoint from one serverless instance. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: deleteServerlessPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance
          from which the tenant endpoint will be removed.
        in: path
        name: instanceName
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the tenant
          endpoint which will be removed.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
    get:
      description: Return one private endpoint for one serverless instance. Identify
        this endpoint using its unique ID. You must have at least the Project Read
        Only role for the project to successfully call this resource.
      operationId: getServerlessPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance
          associated with the tenant endpoint.
        in: path
        name: instanceName
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the tenant
          endpoint.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessTenantEndpoint'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
    patch:
      description: "Updates one private endpoint for one serverless instance. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: updateServerlessPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance
          associated with the tenant endpoint that will be updated.
        in: path
        name: instanceName
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the tenant
          endpoint which will be updated.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ServerlessTenantEndpointUpdate'
        description: Object used for update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessTenantEndpoint'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
  /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService:
    get:
      description: "Returns the name, interfaces, and state of all private endpoint\
        \ services for the specified cloud service provider. This cloud service provider\
        \ manages the private endpoint service for the project. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: listPrivateEndpointServices
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Cloud service provider that manages this private endpoint service.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EndpointService'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Private Endpoint Services for One Provider
      tags:
      - Private Endpoint Services
  /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}:
    delete:
      description: "Removes one private endpoint service from the specified project.\
        \ This cloud service provider manages the private endpoint service that belongs\
        \ to the project. To use this resource, the requesting API Key must have the\
        \ Project Owner role."
      operationId: deletePrivateEndpointService
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Cloud service provider that manages this private endpoint service.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service that you want to delete.
        in: path
        name: endpointServiceId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
    get:
      description: "Returns the name, interfaces, and state of the specified private\
        \ endpoint service from one project. The cloud service provider hosted this\
        \ private endpoint service that belongs to the project. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: getPrivateEndpointService
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Cloud service provider that manages this private endpoint service.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service that you want to return.
        in: path
        name: endpointServiceId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/EndpointService'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
  /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint:
    post:
      description: "Creates one private endpoint for the specified cloud service provider.\
        \ This cloud service provider manages the private endpoint service, which\
        \ in turn manages the private endpoints for the project. To use this resource,\
        \ the requesting API Key must have the Project Owner role. To learn more about\
        \ considerations, limitations, and prerequisites, see the MongoDB documentation\
        \ for setting up a private endpoint."
      operationId: createPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Cloud service provider that manages this private endpoint.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service for which you want to create a private endpoint.
        in: path
        name: endpointServiceId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CreateEndpointRequest'
        description: Creates one private endpoint for the specified cloud service
          provider.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PrivateLinkEndpoint'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Private Endpoint for One Provider
      tags:
      - Private Endpoint Services
  /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}:
    delete:
      description: "Removes one private endpoint from the specified project and private\
        \ endpoint service, as managed by the specified cloud service provider. When\
        \ the last private endpoint is removed from a given private endpoint service,\
        \ that private endpoint service is also removed. To use this resource, the\
        \ requesting API Key must have the Project Owner role."
      operationId: deletePrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Cloud service provider that manages this private endpoint.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      - description: Unique string that identifies the private endpoint you want to
          delete. The format of the **endpointId** parameter differs for AWS and Azure.
          You must URL encode the **endpointId** for Azure private endpoints.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          pattern: "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\\
            w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\\
            w._()]+)"
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service from which you want to delete a private endpoint.
        in: path
        name: endpointServiceId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Private Endpoint for One Provider
      tags:
      - Private Endpoint Services
    get:
      description: "Returns the connection state of the specified private endpoint.\
        \ The private endpoint service manages this private endpoint which belongs\
        \ to one project hosted from one cloud service provider. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: getPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Cloud service provider that manages this private endpoint.
        in: path
        name: cloudProvider
        required: true
        schema:
          type: string
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
      - description: Unique string that identifies the private endpoint you want to
          return. The format of the **endpointId** parameter differs for AWS and Azure.
          You must URL encode the **endpointId** for Azure private endpoints.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          pattern: "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\\
            w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\\
            w._()]+)"
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service for which you want to return a private endpoint.
        in: path
        name: endpointServiceId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PrivateLinkEndpoint'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Private Endpoint for One Provider
      tags:
      - Private Endpoint Services
  /api/atlas/v2/groups/{groupId}/privateIpMode:
    get:
      deprecated: true
      description: "Verifies if someone set the specified project to **Connect via\
        \ Peering Only** mode. To use this resource, the requesting API Key must have\
        \ the Project Read Only role."
      externalDocs:
        description: Changes to Connection Strings
        url: https://docs.atlas.mongodb.com/reference/faq/connection-changes/
      operationId: verifyConnectViaPeeringOnlyModeForOneProject
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PrivateIPModeView'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Verify Connect via Peering Only Mode for One Project
      tags:
      - Network Peering
    patch:
      deprecated: true
      description: "Disables Connect via Peering Only mode for the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      externalDocs:
        description: Changes to Connection Strings
        url: https://docs.atlas.mongodb.com/reference/faq/connection-changes/
      operationId: disablePeering
      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/PrivateIPModeView'
        description: Disables Connect via Peering Only mode for the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PrivateIPModeView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Disable Connect via Peering Only Mode for One Project
      tags:
      - Network Peering
  /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds:
    get:
      description: "Returns all private endpoints for Federated Database Instances\
        \ and Online Archives in the specified project. To use this resource, the\
        \ requesting API Key must have the Project Read Only or Project Charts Admin\
        \ roles."
      operationId: listDataFederationPrivateEndpoints
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Federated Database Instance and Online Archive Private Endpoints
        in One Project
      tags:
      - Data Federation
    post:
      description: |-
        Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region.

         `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.

         `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.

         `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.

         `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.

         `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.

         `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.

         `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.

         `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.

         To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.
      operationId: createDataFederationPrivateEndpoint
      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/PrivateNetworkEndpointIdEntry'
        description: Private endpoint for Federated Database Instances and Online
          Archives to add to the specified project.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Federated Database Instance and Online Archive Private Endpoint
        for One Project
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}:
    delete:
      description: "Removes one private endpoint for Federated Database Instances\
        \ and Online Archives in the specified project. To use this resource, the\
        \ requesting API Key must have the Project Owner role."
      operationId: deleteDataFederationPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 22-character alphanumeric string that identifies the private
          endpoint to remove. Atlas Data Federation supports AWS private endpoints
          using the AWS PrivateLink feature.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          maxLength: 22
          minLength: 22
          pattern: "^vpce-[0-9a-f]{17}$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Federated Database Instance and Online Archive Private Endpoint
        from One Project
      tags:
      - Data Federation
    get:
      description: "Returns the specified private endpoint for Federated Database\
        \ Instances or Online Archives in the specified project. To use this resource,\
        \ the requesting API Key must have the Project Read Only or Project Charts\
        \ Admin roles."
      operationId: getDataFederationPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 22-character alphanumeric string that identifies the private
          endpoint to return. Atlas Data Federation supports AWS private endpoints
          using the AWS PrivateLink feature.
        in: path
        name: endpointId
        required: true
        schema:
          type: string
          maxLength: 22
          minLength: 22
          pattern: "^vpce-[0-9a-f]{17}$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PrivateNetworkEndpointIdEntry'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Federated Database Instance and Online Archive Private Endpoint
        in One Project
      tags:
      - Data Federation
  /api/atlas/v2/groups/{groupId}/processes:
    get:
      description: "Returns details of all processes for the specified project. A\
        \ MongoDB process can be either a `mongod` or `mongos`. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: listAtlasProcesses
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedHostView_Atlas'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All MongoDB Processes in One Project
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}:
    get:
      description: "Returns the processes for the specified host for the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getAtlasProcess
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiHostView_Atlas'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One MongoDB Process by ID
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces:
    get:
      description: Return the subset of namespaces from the given process ranked by
        highest total execution time (descending) within the given time window.
      operationId: getCollStatsLatencyNamespacesForHost
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/processId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/period'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/CollStatsRankedNamespacesView'
              x-xgen-version: 2023-11-15
          description: Succeeded
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Ranked Namespaces from a Host
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/processes/{processId}/databases:
    get:
      description: "Returns the list of databases running on the specified host for\
        \ the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters\
        \ have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations).\
        \ The MongoDB Cloud process must be a `mongod`. To use this resource, the\
        \ requesting API Key must have the Project Read Only role."
      operationId: listDatabases
      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: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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`). The port\
          \ must be the IANA port on which the MongoDB process listens for requests."
        in: path
        name: processId
        required: true
        schema:
          type: string
          example: mongodb.example.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})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedDatabaseView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Available Databases for One MongoDB Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}:
    get:
      description: "Returns one database running on the specified host for the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getDatabase
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the database that the specified
          MongoDB process serves.
        in: path
        name: databaseName
        required: true
        schema:
          type: string
      - description: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MesurementsDatabase'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Database for a MongoDB Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements:
    get:
      description: "Returns the measurements of one database for the specified host\
        \ for the specified project. Returns the database's on-disk storage space\
        \ based on the MongoDB `dbStats` command output. To calculate some metric\
        \ series, Atlas takes the rate between every two adjacent points. For these\
        \ metric series, the first data point has a null value because Atlas can't\
        \ calculate a rate for the first data point given the query time range. Atlas\
        \ retrieves database metrics every 20 minutes but reduces frequency when necessary\
        \ to optimize database performance. To use this resource, the requesting API\
        \ Key must have the Project Read Only role."
      operationId: getDatabaseMeasurements
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the database that the specified
          MongoDB process serves.
        in: path
        name: databaseName
        required: true
        schema:
          type: string
      - description: "One or more types of measurement to request for this MongoDB\
          \ process. If omitted, the resource returns all measurements. To specify\
          \ multiple values for `m`, repeat the `m` parameter for each value. Specify\
          \ measurements that apply to the specified host. MongoDB Cloud returns an\
          \ error if you specified any invalid measurements."
        in: query
        name: m
        schema:
          type: array
          items:
            type: string
            description: One measurement requested for this MongoDB process.
            enum:
            - DATABASE_AVERAGE_OBJECT_SIZE
            - DATABASE_COLLECTION_COUNT
            - DATABASE_DATA_SIZE
            - DATABASE_STORAGE_SIZE
            - DATABASE_INDEX_SIZE
            - DATABASE_INDEX_COUNT
            - DATABASE_EXTENT_COUNT
            - DATABASE_OBJECT_COUNT
            - DATABASE_VIEW_COUNT
          maxItems: 10
          minItems: 1
          uniqueItems: true
        style: form
      - description: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      - $ref: '#/components/parameters/granularity'
      - $ref: '#/components/parameters/period'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Measurements of One Database for One MongoDB Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/disks:
    get:
      description: "Returns the list of disks or partitions for the specified host\
        \ for the specified project. To use this resource, the requesting API Key\
        \ must have the Project Read Only role."
      operationId: listDiskPartitions
      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: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedDiskPartitionView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Available Disks for One MongoDB Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}:
    get:
      description: "Returns measurement details for one disk or partition for the\
        \ specified host for the specified project. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      operationId: listDiskMeasurements
      parameters:
      - $ref: '#/components/parameters/envelope'
      - description: Human-readable label of the disk or partition to which the measurements
          apply.
        in: path
        name: partitionName
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/groupId'
      - description: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/MeasurementDiskPartition'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Measurements of One Disk
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements:
    get:
      description: |-
        Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:
        - Throughput of I/O operations for the disk partition used for the MongoDB process
        - Percentage of time during which requests the partition issued and serviced
        - Latency per operation type of the disk partition used for the MongoDB process
        - Amount of free and used disk space on the disk partition used for the MongoDB process

        To use this resource, the requesting API Key must have the Project Read Only role.
      operationId: getDiskMeasurements
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "One or more types of measurement to request for this MongoDB\
          \ process. If omitted, the resource returns all measurements. To specify\
          \ multiple values for `m`, repeat the `m` parameter for each value. Specify\
          \ measurements that apply to the specified host. MongoDB Cloud returns an\
          \ error if you specified any invalid measurements."
        in: query
        name: m
        schema:
          type: array
          items:
            type: string
            description: One measurement requested for this MongoDB process.
            enum:
            - DISK_PARTITION_IOPS_READ
            - MAX_DISK_PARTITION_IOPS_READ
            - DISK_PARTITION_IOPS_WRITE
            - MAX_DISK_PARTITION_IOPS_WRITE
            - DISK_PARTITION_IOPS_TOTAL
            - MAX_DISK_PARTITION_IOPS_TOTAL
            - DISK_PARTITION_LATENCY_READ
            - MAX_DISK_PARTITION_LATENCY_READ
            - DISK_PARTITION_LATENCY_WRITE
            - MAX_DISK_PARTITION_LATENCY_WRITE
            - DISK_PARTITION_SPACE_FREE
            - MAX_DISK_PARTITION_SPACE_FREE
            - DISK_PARTITION_SPACE_USED
            - MAX_DISK_PARTITION_SPACE_USED
            - DISK_PARTITION_SPACE_PERCENT_FREE
            - MAX_DISK_PARTITION_SPACE_PERCENT_FREE
            - DISK_PARTITION_SPACE_PERCENT_USED
            - MAX_DISK_PARTITION_SPACE_PERCENT_USED
          maxItems: 10
          minItems: 1
          uniqueItems: true
        style: form
      - description: Human-readable label of the disk or partition to which the measurements
          apply.
        in: path
        name: partitionName
        required: true
        schema:
          type: string
      - description: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      - $ref: '#/components/parameters/granularity'
      - $ref: '#/components/parameters/period'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Measurements of One Disk for One MongoDB Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements:
    get:
      description: |-
        Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:
        - Throughput of I/O operations for the disk partition used for the MongoDB process
        - Percentage of time during which requests the partition issued and serviced
        - Latency per operation type of the disk partition used for the MongoDB process
        - Amount of free and used disk space on the disk partition used for the MongoDB process
        - Measurements for the host, such as CPU usage or number of I/O operations

        To use this resource, the requesting API Key must have the Project Read Only role.
      operationId: getHostMeasurements
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "One or more types of measurement to request for this MongoDB\
          \ process. If omitted, the resource returns all measurements. To specify\
          \ multiple values for `m`, repeat the `m` parameter for each value. Specify\
          \ measurements that apply to the specified host. MongoDB Cloud returns an\
          \ error if you specified any invalid measurements."
        in: query
        name: m
        schema:
          type: array
          items:
            type: string
            description: One measurement requested for this MongoDB process.
            enum:
            - ASSERT_MSG
            - ASSERT_REGULAR
            - ASSERT_USER
            - ASSERT_WARNING
            - BACKGROUND_FLUSH_AVG
            - CACHE_BYTES_READ_INTO
            - CACHE_BYTES_WRITTEN_FROM
            - CACHE_DIRTY_BYTES
            - CACHE_USED_BYTES
            - COMPUTED_MEMORY
            - CONNECTIONS
            - CURSORS_TOTAL_OPEN
            - CURSORS_TOTAL_TIMED_OUT
            - DB_DATA_SIZE_TOTAL
            - DB_STORAGE_TOTAL
            - DOCUMENT_METRICS_DELETED
            - DOCUMENT_METRICS_INSERTED
            - DOCUMENT_METRICS_RETURNED
            - DOCUMENT_METRICS_UPDATED
            - EXTRA_INFO_PAGE_FAULTS
            - FTS_DISK_UTILIZATION
            - FTS_MEMORY_MAPPED
            - FTS_MEMORY_RESIDENT
            - FTS_MEMORY_VIRTUAL
            - FTS_PROCESS_CPU_KERNEL
            - FTS_PROCESS_CPU_USER
            - FTS_PROCESS_NORMALIZED_CPU_KERNEL
            - FTS_PROCESS_NORMALIZED_CPU_USER
            - GLOBAL_ACCESSES_NOT_IN_MEMORY
            - GLOBAL_LOCK_CURRENT_QUEUE_READERS
            - GLOBAL_LOCK_CURRENT_QUEUE_TOTAL
            - GLOBAL_LOCK_CURRENT_QUEUE_WRITERS
            - GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN
            - INDEX_COUNTERS_BTREE_ACCESSES
            - INDEX_COUNTERS_BTREE_HITS
            - INDEX_COUNTERS_BTREE_MISS_RATIO
            - INDEX_COUNTERS_BTREE_MISSES
            - JOURNALING_COMMITS_IN_WRITE_LOCK
            - JOURNALING_MB
            - JOURNALING_WRITE_DATA_FILES_MB
            - MAX_PROCESS_CPU_CHILDREN_KERNEL
            - MAX_PROCESS_CPU_CHILDREN_USER
            - MAX_PROCESS_CPU_KERNEL
            - MAX_PROCESS_CPU_USER
            - MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL
            - MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER
            - MAX_PROCESS_NORMALIZED_CPU_KERNEL
            - MAX_PROCESS_NORMALIZED_CPU_USER
            - MAX_SWAP_USAGE_FREE
            - 'MAX_SWAP_USAGE_USED '
            - MAX_SYSTEM_CPU_GUEST
            - MAX_SYSTEM_CPU_IOWAIT
            - MAX_SYSTEM_CPU_IRQ
            - MAX_SYSTEM_CPU_KERNEL
            - MAX_SYSTEM_CPU_SOFTIRQ
            - MAX_SYSTEM_CPU_STEAL
            - MAX_SYSTEM_CPU_USER
            - MAX_SYSTEM_MEMORY_AVAILABLE
            - MAX_SYSTEM_MEMORY_FREE
            - MAX_SYSTEM_MEMORY_USED
            - MAX_SYSTEM_NETWORK_IN
            - MAX_SYSTEM_NETWORK_OUT
            - MAX_SYSTEM_NORMALIZED_CPU_GUEST
            - MAX_SYSTEM_NORMALIZED_CPU_IOWAIT
            - MAX_SYSTEM_NORMALIZED_CPU_IRQ
            - MAX_SYSTEM_NORMALIZED_CPU_KERNEL
            - MAX_SYSTEM_NORMALIZED_CPU_NICE
            - MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ
            - MAX_SYSTEM_NORMALIZED_CPU_STEAL
            - MAX_SYSTEM_NORMALIZED_CPU_USER
            - MEMORY_MAPPED
            - MEMORY_RESIDENT
            - MEMORY_VIRTUAL
            - NETWORK_BYTES_IN
            - NETWORK_BYTES_OUT
            - NETWORK_NUM_REQUESTS
            - OP_EXECUTION_TIME_COMMANDS
            - OP_EXECUTION_TIME_READS
            - OP_EXECUTION_TIME_WRITES
            - OPCOUNTER_CMD
            - OPCOUNTER_DELETE
            - OPCOUNTER_GETMORE
            - OPCOUNTER_INSERT
            - OPCOUNTER_QUERY
            - OPCOUNTER_REPL_CMD
            - OPCOUNTER_REPL_DELETE
            - OPCOUNTER_REPL_INSERT
            - OPCOUNTER_REPL_UPDATE
            - OPCOUNTER_UPDATE
            - OPERATIONS_SCAN_AND_ORDER
            - OPLOG_MASTER_LAG_TIME_DIFF
            - OPLOG_MASTER_TIME
            - OPLOG_RATE_GB_PER_HOUR
            - OPLOG_SLAVE_LAG_MASTER_TIME
            - OPLOG_REPLICATION_LAG
            - PROCESS_CPU_CHILDREN_KERNEL
            - PROCESS_CPU_CHILDREN_USER
            - PROCESS_CPU_KERNEL
            - PROCESS_CPU_USER
            - PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL
            - PROCESS_NORMALIZED_CPU_CHILDREN_USER
            - PROCESS_NORMALIZED_CPU_KERNEL
            - PROCESS_NORMALIZED_CPU_USER
            - QUERY_EXECUTOR_SCANNED
            - QUERY_EXECUTOR_SCANNED_OBJECTS
            - QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED
            - QUERY_TARGETING_SCANNED_PER_RETURNED
            - RESTARTS_IN_LAST_HOUR
            - SWAP_USAGE_FREE
            - SWAP_USAGE_USED
            - SYSTEM_CPU_GUEST
            - SYSTEM_CPU_IOWAIT
            - SYSTEM_CPU_IRQ
            - SYSTEM_CPU_KERNEL
            - SYSTEM_CPU_NICE
            - SYSTEM_CPU_SOFTIRQ
            - SYSTEM_CPU_STEAL
            - SYSTEM_CPU_USER
            - SYSTEM_MEMORY_AVAILABLE
            - SYSTEM_MEMORY_FREE
            - SYSTEM_MEMORY_USED
            - SYSTEM_NETWORK_IN
            - SYSTEM_NETWORK_OUT
            - SYSTEM_NORMALIZED_CPU_GUEST
            - SYSTEM_NORMALIZED_CPU_IOWAIT
            - SYSTEM_NORMALIZED_CPU_IRQ
            - SYSTEM_NORMALIZED_CPU_KERNEL
            - SYSTEM_NORMALIZED_CPU_NICE
            - SYSTEM_NORMALIZED_CPU_SOFTIRQ
            - SYSTEM_NORMALIZED_CPU_STEAL
            - SYSTEM_NORMALIZED_CPU_USER
            - TICKETS_AVAILABLE_READS
            - TICKETS_AVAILABLE_WRITE
          maxItems: 10
          minItems: 1
          uniqueItems: true
        style: form
      - $ref: '#/components/parameters/period'
      - description: "Combination of hostname and Internet Assigned Numbers Authority\
          \ (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:
          type: string
          example: mongodb.example.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})$"
      - $ref: '#/components/parameters/granularity'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiMeasurementsGeneralView_Atlas'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Measurements for One MongoDB Process
      tags:
      - Monitoring and Logs
  /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces:
    get:
      description: "Returns up to 20 namespaces for collections experiencing slow\
        \ queries on the specified host. If you specify a secondary member of a replica\
        \ set that hasn't received any database read operations, the endpoint doesn't\
        \ return any namespaces. To use this resource, the requesting API Key must\
        \ have the Project Read Only role."
      operationId: listSlowQueryNamespaces
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: |-
          Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

          - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.
          - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: duration
        schema:
          type: integer
          format: int64
      - description: "Combination of host and port that serves the MongoDB process.\
          \ The host must be the hostname, FQDN, IPv4 address, or IPv6 address 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:
          type: string
          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})$"
      - description: |-
          Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).

          - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.
          - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: since
        schema:
          type: integer
          format: int64
          minimum: 1199145600000
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/Namespaces'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Namespaces for One Host
      tags:
      - Performance Advisor
  /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs:
    get:
      description: "Returns log lines for slow queries that the Performance Advisor\
        \ and Query Profiler identified. The Performance Advisor monitors queries\
        \ that MongoDB considers slow and suggests new indexes to improve query performance.\
        \ MongoDB Cloud bases the threshold for slow queries on the average time of\
        \ operations on your cluster. This enables workload-relevant recommendations.\
        \ To use this resource, the requesting API Key must have the Project Data\
        \ Access Read Write role."
      operationId: listSlowQueries
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: |-
          Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

          - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.
          - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: duration
        schema:
          type: integer
          format: int64
      - description: "Namespaces from which to retrieve slow queries. A namespace\
          \ consists of one database and one collection resource written as `.`: `<database>.<collection>`.\
          \ To include multiple namespaces, pass the parameter multiple times delimited\
          \ with an ampersand (`&`) between each namespace. Omit this parameter to\
          \ return results for all namespaces."
        in: query
        name: namespaces
        schema:
          type: array
          items:
            type: string
        style: form
      - description: Maximum number of lines from the log to return.
        in: query
        name: nLogs
        schema:
          type: integer
          format: int64
          default: 20000
          maximum: 20000
          minimum: 0
      - description: "Combination of host and port that serves the MongoDB process.\
          \ The host must be the hostname, FQDN, IPv4 address, or IPv6 address 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:
          type: string
          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})$"
      - description: |-
          Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).

          - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.
          - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: since
        schema:
          type: integer
          format: int64
          minimum: 1199145600000
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PerformanceAdvisorSlowQueryList'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Slow Queries
      tags:
      - Performance Advisor
  /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes:
    get:
      description: "Returns the indexes that the Performance Advisor suggests. The\
        \ Performance Advisor monitors queries that MongoDB considers slow and suggests\
        \ new indexes to improve query performance. To use this resource, the requesting\
        \ API Key must have the Project Read Only role."
      operationId: listSuggestedIndexes
      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: |-
          Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

          - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.
          - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: duration
        schema:
          type: integer
          format: int64
      - description: "Namespaces from which to retrieve suggested indexes. A namespace\
          \ consists of one database and one collection resource written as `.`: `<database>.<collection>`.\
          \ To include multiple namespaces, pass the parameter multiple times delimited\
          \ with an ampersand (`&`) between each namespace. Omit this parameter to\
          \ return results for all namespaces."
        in: query
        name: namespaces
        schema:
          type: array
          items:
            type: string
        style: form
      - description: Maximum number of example queries that benefit from the suggested
          index.
        in: query
        name: nExamples
        schema:
          type: integer
          format: int64
          default: 5
      - description: Number that indicates the maximum indexes to suggest.
        in: query
        name: nIndexes
        schema:
          type: integer
          format: int64
      - description: "Combination of host and port that serves the MongoDB process.\
          \ The host must be the hostname, FQDN, IPv4 address, or IPv6 address 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:
          type: string
          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})$"
      - description: |-
          Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).

          - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.
          - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: since
        schema:
          type: integer
          format: int64
          minimum: 1199145600000
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PerformanceAdvisorResponse'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Suggested Indexes
      tags:
      - Performance Advisor
  /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements:
    get:
      description: Get a list of the Coll Stats Latency process-level measurements
        for the given namespace
      operationId: getCollStatsLatencyNamespaceHostMeasurements
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/processId'
      - $ref: '#/components/parameters/databaseName'
      - $ref: '#/components/parameters/collectionName'
      - $ref: '#/components/parameters/envelope'
      - description: "List that contains the metrics that you want to retrieve for\
          \ the associated data series. If you don't set this parameter, this resource\
          \ returns data series for all Coll Stats Latency metrics."
        in: query
        name: metrics
        schema:
          type: array
          items:
            type: string
            description: Metric requested for the given process
            enum:
            - READS_OPS
            - READS_LATENCY
            - AVERAGE_READS_LATENCY
            - READS_P50_VALUE
            - READS_P95_VALUE
            - READS_P99_VALUE
            - WRITES_OPS
            - WRITES_LATENCY
            - AVERAGE_WRITES_LATENCY
            - WRITES_P50_VALUE
            - WRITES_P95_VALUE
            - WRITES_P99_VALUE
            - COMMANDS_OPS
            - COMMANDS_LATENCY
            - AVERAGE_COMMANDS_LATENCY
            - COMMANDS_P50_VALUE
            - COMMANDS_P95_VALUE
            - COMMANDS_P99_VALUE
            - TOTAL_OPS
            - TOTAL_LATENCY
            - AVERAGE_TOTAL_OPS_LATENCY
            - TOTAL_OPS_P50_VALUE
            - TOTAL_OPS_P95_VALUE
            - TOTAL_OPS_P99_VALUE
          uniqueItems: true
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/period'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/MeasurementsCollStatsLatencyHost'
              x-xgen-version: 2023-11-15
          description: Succeeded
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Host-Level Query Latency
      tags:
      - Collection Level Metrics
  /api/atlas/v2/groups/{groupId}/pushBasedLogExport:
    delete:
      description: Disables the push-based log export feature by resetting the project
        level settings to its default configuration.
      operationId: deletePushBasedLogConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Disable the push-based log export feature for a project
      tags:
      - Push-Based Log Export
    get:
      description: Fetches the current project level settings for the push-based log
        export feature.
      operationId: getPushBasedLogConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PushBasedLogExportProject'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Get the push-based log export configuration for a project
      tags:
      - Push-Based Log Export
    patch:
      description: Updates the project level settings for the push-based log export
        feature.
      operationId: updatePushBasedLogConfiguration
      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/PushBasedLogExportProject'
            x-xgen-version: 2023-01-01
        description: "The project configuration details. The S3 bucket name, IAM role\
          \ ID, and prefix path fields are the only fields that may be specified.\
          \ Fields left unspecified will not be modified."
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update the push-based log export feature for a project
      tags:
      - Push-Based Log Export
    post:
      description: Configures the project level settings for the push-based log export
        feature.
      operationId: createPushBasedLogConfiguration
      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/PushBasedLogExportProject'
            x-xgen-version: 2023-01-01
        description: "The project configuration details. The S3 bucket name, IAM role\
          \ ID, and prefix path fields are required."
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Enable the push-based log export feature for a project
      tags:
      - Push-Based Log Export
  /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 API Key must have the Project\
        \ Owner role."
      operationId: loadSampleDataset
      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:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/SampleDatasetStatus'
              x-xgen-version: 2023-01-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Load Sample Dataset Request into Cluster
      tags:
      - Clusters
  /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 API Key must have the Project Owner\
        \ role."
      operationId: getSampleDatasetLoadStatus
      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:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/SampleDatasetStatus'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Check Status of Cluster Sample Dataset Request
      tags:
      - Clusters
  /api/atlas/v2/groups/{groupId}/serverless:
    get:
      description: "Returns details for all serverless instances in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: listServerlessInstances
      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'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedServerlessInstanceDescriptionView'
              x-xgen-version: 2023-01-01
          description: OK
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Serverless Instances from One Project
      tags:
      - Serverless Instances
    post:
      description: "Creates one serverless instance in the specified project. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: createServerlessInstance
      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/ServerlessInstanceDescriptionCreate'
        description: Create One Serverless Instance in One Project.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessInstanceDescription'
              x-xgen-version: 2023-01-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Serverless Instance in One Project
      tags:
      - Serverless Instances
  /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs:
    get:
      description: "Returns all restore jobs for one serverless instance from the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Owner role."
      operationId: listServerlessBackupRestoreJobs
      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: Human-readable label that identifies the serverless instance.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Restore Jobs for One Serverless Instance
      tags:
      - Cloud Backups
    post:
      description: "Restores one snapshot of one serverless instance from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: createServerlessBackupRestoreJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the serverless instance
          whose snapshot you want to restore.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ServerlessBackupRestoreJob'
        description: Restores one snapshot of one serverless instance from the specified
          project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessBackupRestoreJob'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Restore One Snapshot of One Serverless Instance
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}:
    get:
      description: "Returns one restore job for one serverless instance from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: getServerlessBackupRestoreJob
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the serverless instance.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to return.
        in: path
        name: restoreJobId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessBackupRestoreJob'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Restore Job for One Serverless Instance
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots:
    get:
      description: "Returns all snapshots of one serverless instance from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: listServerlessBackups
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - description: Human-readable label that identifies the serverless instance.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Snapshots of One Serverless Instance
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}:
    get:
      description: "Returns one snapshot of one serverless instance from the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getServerlessBackup
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          type: string
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessBackupSnapshot'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Snapshot of One Serverless Instance
      tags:
      - Cloud Backups
  /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing:
    get:
      description: Get whether the Serverless Auto Indexing feature is enabled.
      operationId: getServerlessAutoIndexing
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: boolean
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Serverless Auto Indexing Enabled
      tags:
      - Performance Advisor
    post:
      description: Set whether the Serverless Auto Indexing feature is enabled.
      operationId: setServerlessAutoIndexing
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      - description: Value that we want to set for the Serverless Auto Indexing toggle.
        in: query
        name: enable
        required: true
        schema:
          type: boolean
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Set Serverless Auto Indexing
      tags:
      - Performance Advisor
  /api/atlas/v2/groups/{groupId}/serverless/{name}:
    delete:
      description: "Removes one serverless instance from the specified project. The\
        \ serverless instance must have termination protection disabled in order to\
        \ be deleted. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: deleteServerlessInstance
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the serverless instance.
        in: path
        name: name
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Serverless Instance from One Project
      tags:
      - Serverless Instances
    get:
      description: "Returns details for one serverless instance in the specified project.\
        \ To use this resource, the requesting API Key must have the Project Read\
        \ Only role."
      operationId: getServerlessInstance
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the serverless instance.
        in: path
        name: name
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ServerlessInstanceDescription'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Serverless Instance from One Project
      tags:
      - Serverless Instances
    patch:
      description: "Updates one serverless instance in the specified project. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: updateServerlessInstance
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the serverless instance.
        in: path
        name: name
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/ServerlessInstanceDescriptionUpdate'
        description: Update One Serverless Instance in One 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
        "400":
          $ref: '#/components/responses/badRequest'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "409":
          $ref: '#/components/responses/conflict'
      security:
      - DigestAuth: []
      summary: Update One Serverless Instance in One Project
      tags:
      - Serverless Instances
  /api/atlas/v2/groups/{groupId}/serviceAccounts:
    get:
      description: Returns list of Service Accounts for a project with service account
        details.
      operationId: listProjectServiceAccounts
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupServiceAccounts'
              x-xgen-version: 2023-10-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All project Service Accounts
      tags:
      - Groups
    post:
      description: Creates and assigns the specified Service Account to the specified
        Project.
      operationId: createProjectServiceAccount
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              $ref: '#/components/schemas/GroupServiceAccountRequest'
            x-xgen-version: 2023-10-01
        description: Details to create service account and add to the specified project.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/GroupServiceAccount'
              x-xgen-version: 2023-10-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create and Assign one Service Account to one project
      tags:
      - Groups
  /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}:
    delete:
      description: Removes one Service Account from the specified project.
      operationId: deleteProjectServiceAccount
      parameters:
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-10-01
          description: This endpoint does not return a response body.
          x-xgen-version: 2023-10-01
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Unassign One Service Account from One Project.
      tags:
      - Groups
    get:
      description: Get project Service Account Details.
      operationId: getProjectServiceAccount
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/GroupServiceAccountDetails'
              x-xgen-version: 2023-10-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Fetching
      tags:
      - Groups
    patch:
      description: Update Service Account in Project.
      operationId: updateProjectServiceAccount
      parameters:
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              $ref: '#/components/schemas/GroupServiceAccountUpdateRequest'
        description: Details to update service account in the specified Project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/GroupServiceAccountDetails'
              x-xgen-version: 2023-10-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Update in Project
      tags:
      - Groups
    post:
      description: Assigns the specified organization Service Account to the specified
        project.
      operationId: addProjectServiceAccount
      parameters:
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/GroupServiceAccountRoleAssignment'
            x-xgen-version: 2023-10-01
        description: Service Account Roles to be assigned to the specified project.
        required: true
      responses:
        "204":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-10-01
          description: This endpoint does not return a response body.
          x-xgen-version: 2023-10-01
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Assign One Service Account to One Project
      tags:
      - Groups
  /api/atlas/v2/groups/{groupId}/settings:
    get:
      description: "Returns details about the specified project's settings. To use\
        \ this resource, the requesting API Key must have the Project Read Only role."
      operationId: getProjectSettings
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Project Settings
      tags:
      - Projects
    patch:
      description: "Updates the settings of the specified project. You can update\
        \ any of the options available. MongoDB cloud only updates the options provided\
        \ in the request. To use this resource, the requesting API Key must have the\
        \ Project Owner role."
      operationId: updateProjectSettings
      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/GroupSettings'
        description: Settings to update.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/GroupSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Project Settings
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/streams:
    get:
      description: Returns all stream instances for the specified project.
      operationId: listStreamInstances
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiStreamsTenantView'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Project Stream Instances
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
    post:
      description: "Creates one stream instance in the specified project. To use this\
        \ resource, the requesting API Key must have the Project Owner roles."
      operationId: createStreamInstance
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/StreamsTenant'
        description: Details to create one streams instance in the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/StreamsTenant'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Stream Instance
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
  /api/atlas/v2/groups/{groupId}/streams/{tenantName}:
    delete:
      description: "Delete one stream instance in the specified project. To use this\
        \ resource, the requesting API Key must have the Project Owner roles."
      operationId: deleteStreamInstance
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance to delete.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "202":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-02-01
          description: Accepted
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete One Stream Instance
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
    get:
      description: "Returns the details of one stream instance within the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Read Only role."
      operationId: getStreamInstance
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance to return.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Flag to indicate whether connections information should be included
          in the stream instance.
        in: query
        name: includeConnections
        schema:
          type: boolean
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/StreamsTenant'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Stream Instance
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
    patch:
      description: "Update one stream instance in the specified project. To use this\
        \ resource, the requesting API Key must have the Project Owner roles."
      operationId: updateStreamInstance
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance to update.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/StreamsDataProcessRegion'
        description: Details of the new data process region to update in the streams
          instance.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/StreamsTenant'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Stream Instance
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
  /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs:
    get:
      description: "Downloads the audit logs for the specified Atlas Streams Processing\
        \ instance. By default, logs cover periods of 30 days. To use this resource,\
        \ the requesting API Key must have the Project Owner roles or Project Data\
        \ Access Read Write roles."
      operationId: downloadStreamTenantAuditLogs
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Timestamp that specifies the end point for the range of log messages
          to download.  MongoDB Cloud expresses this timestamp in the number of seconds
          that have elapsed since the UNIX epoch.
        in: query
        name: endDate
        schema:
          type: integer
          format: int64
          example: 1636481348
          pattern: "1199145600"
      - description: Timestamp that specifies the starting point for the range of
          log messages to download. MongoDB Cloud expresses this timestamp in the
          number of seconds that have elapsed since the UNIX epoch.
        in: query
        name: startDate
        schema:
          type: integer
          format: int64
          example: 1636466948
          pattern: "1199145600"
      - description: Human-readable label that identifies the stream instance.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+gzip:
              schema:
                type: string
                format: binary
                description: Compressed archive labeled `auditLogs.gz` downloads
              x-xgen-version: 2023-02-01
          description: OK
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Download Audit Logs for One Atlas Stream Processing Instance
      tags:
      - Streams
  /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections:
    get:
      description: Returns all connections of the stream instance for the specified
        project.
      operationId: listStreamConnections
      parameters:
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label that identifies the stream instance.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiStreamsConnectionView'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Connections Of The Stream Instances
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
    post:
      description: "Creates one connection for a stream instance in the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner roles."
      operationId: createStreamConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/StreamsConnection'
        description: Details to create one connection for a streams instance in the
          specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/StreamsConnection'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "409":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Connection
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
  /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}:
    delete:
      description: "Delete one connection of the specified stream instance. To use\
        \ this resource, the requesting API Key must have the Project Owner roles."
      operationId: deleteStreamConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Human-readable label that identifies the stream connection.
        in: path
        name: connectionName
        required: true
        schema:
          type: string
      responses:
        "202":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-02-01
          description: Accepted
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Delete One Stream Connection
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
    get:
      description: "Returns the details of one stream connection within the specified\
        \ stream instance. To use this resource, the requesting API Key must have\
        \ the Project Read Only role."
      operationId: getStreamConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance to return.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Human-readable label that identifies the stream connection to
          return.
        in: path
        name: connectionName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/StreamsConnection'
              x-xgen-version: 2023-02-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Stream Connection
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
    patch:
      description: "Update one connection for the specified stream instance in the\
        \ specified project. To use this resource, the requesting API Key must have\
        \ the Project Owner roles."
      operationId: updateStreamConnection
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      - description: Human-readable label that identifies the stream instance.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Human-readable label that identifies the stream connection.
        in: path
        name: connectionName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              $ref: '#/components/schemas/StreamsConnection'
        description: Details to update one connection for a streams instance in the
          specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                $ref: '#/components/schemas/StreamsConnection'
              x-xgen-version: 2023-02-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Stream Connection
      tags:
      - Streams
      x-xgen-changelog:
        "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\
          \ part of private preview, but is subject to change until GA."
  /api/atlas/v2/groups/{groupId}/teams:
    get:
      description: "Returns all teams to which the authenticated user has access in\
        \ the project specified using its unique 24-hexadecimal digit identifier.\
        \ All members of the team share the same project access. To use this resource,\
        \ the requesting API Key must have the Project Read Only role."
      operationId: listProjectTeams
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamRoleView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Teams in One Project
      tags:
      - Teams
    post:
      description: "Adds one team to the specified project. All members of the team\
        \ share the same project access. MongoDB Cloud limits the number of users\
        \ to a maximum of 100 teams per project and a maximum of 250 teams per organization.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: addAllTeamsToProject
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/groupId'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TeamRole'
        description: Team to add to the specified project.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamRoleView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Add One or More Teams to One Project
      tags:
      - Teams
  /api/atlas/v2/groups/{groupId}/teams/{teamId}:
    delete:
      description: "Removes one team specified using its unique 24-hexadecimal digit\
        \ identifier from the project specified using its unique 24-hexadecimal digit\
        \ identifier. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: removeProjectTeam
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - description: Unique 24-hexadecimal digit string that identifies the team that
          you want to remove from the specified project.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Team from One Project
      tags:
      - Teams
    patch:
      description: "Updates the project roles assigned to the specified team. You\
        \ can grant team roles for specific projects and grant project access roles\
        \ to users in the team. All members of the team share the same project access.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: updateTeamRoles
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the team for
          which you want to update roles.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/TeamRole'
        description: The project roles assigned to the specified team.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamRoleView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Team Roles in One Project
      tags:
      - Teams
  /api/atlas/v2/groups/{groupId}/userSecurity:
    get:
      description: "Returns the current LDAP configuration for the specified project.\
        \ To use this resource, the requesting API Key must have the Project Owner\
        \ role."
      operationId: getLDAPConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserSecurity'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return the Current LDAP or X.509 Configuration
      tags:
      - LDAP Configuration
    patch:
      description: |-
        Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.

        Updating this configuration triggers a rolling restart of the database.
      operationId: saveLDAPConfiguration
      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/UserSecurity'
        description: Updates the LDAP configuration for the specified project.
        required: true
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserSecurity'
              x-xgen-version: 2023-01-01
          description: Accepted
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Edit the LDAP or X.509 Configuration
      tags:
      - LDAP Configuration
  /api/atlas/v2/groups/{groupId}/userSecurity/customerX509:
    delete:
      description: |-
        Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.

         Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.
      operationId: disableCustomerManagedX509
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserSecurity'
              x-xgen-version: 2023-01-01
          description: Accepted
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Disable Customer-Managed X.509
      tags:
      - X.509 Authentication
  /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping:
    delete:
      description: "Removes the current LDAP Distinguished Name mapping captured in\
        \ the ``userToDNMapping`` document from the LDAP configuration for the specified\
        \ project. To use this resource, the requesting API Key must have the Project\
        \ Owner role."
      operationId: deleteLDAPConfiguration
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserSecurity'
              x-xgen-version: 2023-01-01
          description: Accepted
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove the Current LDAP User to DN Mapping
      tags:
      - LDAP Configuration
  /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify:
    post:
      description: "Verifies the LDAP configuration for the specified project. To\
        \ use this resource, the requesting API Key must have the Project Owner role."
      operationId: verifyLDAPConfiguration
      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/LDAPVerifyConnectivityJobRequestParams'
        description: The LDAP configuration for the specified project that you want
          to verify.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/LDAPVerifyConnectivityJobRequest'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Verify the LDAP Configuration in One Project
      tags:
      - LDAP Configuration
  /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}:
    get:
      description: "Returns the status of one request to verify one LDAP configuration\
        \ for the specified project. To use this resource, the requesting API Key\
        \ must have the Project Owner role."
      operationId: getLDAPConfigurationStatus
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique string that identifies the request to verify an <abbr
          title="Lightweight Directory Access Protocol">LDAP</abbr> configuration.
        in: path
        name: requestId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/LDAPVerifyConnectivityJobRequest'
              x-xgen-version: 2023-01-01
          description: OK
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return the Status of One Verify LDAP Configuration Request
      tags:
      - LDAP Configuration
  /api/atlas/v2/groups/{groupId}/users:
    get:
      description: "Returns details about all users in the specified project. Users\
        \ belong to an organization. To use this resource, the requesting API Key\
        \ must have the Project Read Only role."
      operationId: listProjectUsers
      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 the returned list should include\
          \ users who belong to a team with a role in this project. You might not\
          \ have assigned the individual users a role in this project. If `\"flattenTeams\"\
          \ : false`, this resource returns only users with a role in the project.\
          \  If `\"flattenTeams\" : true`, this resource returns both users with roles\
          \ in the project and users who belong to teams with roles in the project."
        in: query
        name: flattenTeams
        schema:
          type: boolean
          default: false
      - description: "Flag that indicates whether the returned list should include\
          \ users with implicit access to the project, the Organization Owner or Organization\
          \ Read Only role. You might not have assigned the individual users a role\
          \ in this project. If `\"includeOrgUsers\": false`, this resource returns\
          \ only users with a role in the project. If `\"includeOrgUsers\": true`,\
          \ this resource returns both users with roles in the project and users who\
          \ have implicit access to the project through their organization role."
        in: query
        name: includeOrgUsers
        schema:
          type: boolean
          default: false
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAppUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Users in One Project
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/users/{userId}:
    delete:
      description: "Removes the specified user from the specified project. To use\
        \ this resource, the requesting API Key must have the Project Owner role."
      operationId: removeProjectUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/groupId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal string that identifies MongoDB Cloud user\
          \ you want to remove from the specified project. To return a application\
          \ user's ID using their application username, use the Get All application\
          \ users in One Project endpoint."
        in: path
        name: userId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One User from One Project
      tags:
      - Projects
  /api/atlas/v2/groups/{groupId}/users/{userId}/roles:
    put:
      description: "Updates the roles of the specified user in the specified project.\
        \ To specify the user to update, provide the unique 24-hexadecimal digit string\
        \ that identifies the user in the specified project. To use this resource,\
        \ the requesting API Key must have the Group User Admin role."
      operationId: updateProjectRoles
      parameters:
      - $ref: '#/components/parameters/groupId'
      - description: Unique 24-hexadecimal digit string that identifies the user to
          modify.
        in: path
        name: userId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/UpdateGroupRolesForUser'
        description: Roles to update for the specified user.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UpdateGroupRolesForUser'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Project Roles for One MongoDB Cloud User
      tags:
      - Projects
  /api/atlas/v2/orgs:
    get:
      description: "Returns all organizations to which the requesting API Key has\
        \ access. To use this resource, the requesting API Key must have the Organization\
        \ Member role."
      operationId: listOrganizations
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label of the organization to use to filter the
          returned list. Performs a case-insensitive search for an organization that
          starts with the specified name.
        in: query
        name: name
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedOrganizationView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Organizations
      tags:
      - Organizations
    post:
      description: "Creates one organization in MongoDB Cloud and links it to the\
        \ requesting API Key's organization. To use this resource, the requesting\
        \ API Key must have the Organization Owner role. The requesting API Key's\
        \ organization must be a paying organization. To learn more, see [Configure\
        \ a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization)\
        \ in the MongoDB Atlas documentation."
      operationId: createOrganization
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationRequest'
        description: Organization that you want to create.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CreateOrganizationResponse'
              x-xgen-version: 2023-01-01
          description: Created
        "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'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}:
    delete:
      description: |-
        Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:

         - Organizations with active projects cannot be removed.
         - All projects in the organization must be removed before you can remove the organization.
         To use this resource, the requesting API Key must have the Organization Owner role.
      operationId: deleteOrganization
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "402":
          $ref: '#/components/responses/paymentRequired'
        "403":
          $ref: '#/components/responses/forbidden'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Organization
      tags:
      - Organizations
    get:
      description: "Returns one organization to which the requesting API key has access.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Member role."
      operationId: getOrganization
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AtlasOrganization'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Organization
      tags:
      - Organizations
    patch:
      description: "Renames one organization. To use this resource, the requesting\
        \ API Key must have the Organization Owner role."
      operationId: renameOrganization
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/AtlasOrganization'
        description: Details to update on the specified organization.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/AtlasOrganization'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Rename One Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/apiKeys:
    get:
      description: "Returns all organization API keys for the specified organization.\
        \ The organization API keys grant programmatic access to an organization.\
        \ You can't use the API key to log into MongoDB Cloud through the console.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Member role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: listApiKeys
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiApiUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Organization API Keys
      tags:
      - Programmatic API Keys
    post:
      description: "Creates one API key for the specified organization. An organization\
        \ API key grants programmatic access to an organization. You can't use the\
        \ API key to log into the console. To use this resource, the requesting API\
        \ Key must have the Organization Owner role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: createApiKey
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CreateAtlasOrganizationApiKey'
        description: Organization API Key to be created.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiKeyUserDetails'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Organization API Key
      tags:
      - Programmatic API Keys
  /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}:
    delete:
      description: "Removes one organization API key from the specified organization.\
        \ When you remove an API key from an organization, MongoDB Cloud also removes\
        \ that key from any projects that use that key. To use this resource, the\
        \ requesting API Key must have the Organization Owner role."
      externalDocs:
        description: Configure Atlas API Access
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list
      operationId: deleteApiKey
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Organization API Key
      tags:
      - Programmatic API Keys
    get:
      description: "Returns one organization API key. The organization API keys grant\
        \ programmatic access to an organization. You can't use the API key to log\
        \ into MongoDB Cloud through the user interface. To use this resource, the\
        \ requesting API Key must have the  Organization Member role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: getApiKey
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key that  you want to update.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiKeyUserDetails'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Organization API Key
      tags:
      - Programmatic API Keys
    patch:
      description: "Updates one organization API key in the specified organization.\
        \ The organization API keys  grant programmatic access to an organization.\
        \ To use this resource, the requesting  API Key must have the Organization\
        \ Owner role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: updateApiKey
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key you  want to update.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/UpdateAtlasOrganizationApiKey'
        description: Organization API key to be updated. This request requires a minimum
          of one of the two body parameters.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/ApiKeyUserDetails'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Organization API Key
      tags:
      - Programmatic API Keys
  /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList:
    get:
      description: "Returns all access list entries that you configured for the specified\
        \ organization API key. To use this resource, the requesting API Key must\
        \ have the Organization Member role."
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization
      operationId: listApiKeyAccessListsEntries
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key for which you want to return access list entries.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiUserAccessListResponseView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Access List Entries for One Organization API Key
      tags:
      - Programmatic API Keys
    post:
      description: "Creates the access list entries for the specified organization\
        \ API key. Resources require all API requests originate from IP addresses\
        \ on the API access list. To use this resource, the requesting API Key must\
        \ have the Read Write role."
      operationId: createApiKeyAccessList
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key for which you want to create a new access list entry.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserAccessListRequest'
        description: Access list entries to be created for the specified organization
          API key.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiUserAccessListResponseView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create Access List Entries for One Organization API Key
      tags:
      - Programmatic API Keys
  /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}:
    delete:
      description: "Removes the specified access list entry from the specified organization\
        \ API key. Resources require all API requests originate from the IP addresses\
        \ on the API access list. To use this resource, the requesting API Key must\
        \ have the Read Write role. In addition, you cannot remove the requesting\
        \ IP address from the requesting organization API key."
      externalDocs:
        description: Configure Atlas API Access
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list
      operationId: deleteApiKeyAccessListEntry
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key for which you want to remove access list entries.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: "One IP address or multiple IP addresses represented as one CIDR\
          \ block to limit requests to API resources in the specified organization.\
          \ When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use\
          \ the URL-encoded value %2F for the forward slash /."
        in: path
        name: ipAddress
        required: true
        schema:
          type: string
          example: 192.0.2.0%2F24
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\
            :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Access List Entry for One Organization API Key
      tags:
      - Programmatic API Keys
    get:
      description: "Returns one access list entry for the specified organization API\
        \ key. Resources require  all API requests originate from IP addresses on\
        \ the API access list. To use this resource, the requesting API Key must have\
        \ the Organization Member role."
      externalDocs:
        description: Configure Atlas API Access
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list
      operationId: getApiKeyAccessList
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: "One IP address or multiple IP addresses represented as one CIDR\
          \ block to limit  requests to API resources in the specified organization.\
          \ When adding a CIDR block with a subnet mask, such as  192.0.2.0/24, use\
          \ the URL-encoded value %2F for the forward slash /."
        in: path
        name: ipAddress
        required: true
        schema:
          type: string
          example: 192.0.2.0%2F24
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\
            :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$"
      - description: Unique 24-hexadecimal digit string that identifies this organization
          API key for  which you want to return access list entries.
        in: path
        name: apiUserId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UserAccessListResponse'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Access List Entry for One Organization API Key
      tags:
      - Programmatic API Keys
  /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage:
    post:
      description: Creates a query process within the Cost Explorer for the given
        parameters. A token is returned that can be used to poll the status of the
        query and eventually retrieve the results.
      operationId: createCostExplorerQueryProcess
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CostExplorerFilterRequestBody'
        description: Filter parameters for the Cost Explorer query.
        required: true
      responses:
        "202":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CostExplorerFilterResponseView'
              x-xgen-version: 2023-01-01
          description: Accepted
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create Cost Explorer query process
      tags:
      - Invoices
  /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}:
    get:
      description: "Returns the usage details for a Cost Explorer query, if the query\
        \ is finished and the data is ready to be viewed. If the data is not ready,\
        \ a 'processing' response willindicate that another request should be sent\
        \ later to view the data."
      operationId: createCostExplorerQueryProcess_1
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - description: Unique 64 digit string that identifies the Cost Explorer query.
        in: path
        name: token
        required: true
        schema:
          type: string
          example: 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C
          maxLength: 64
          minLength: 64
      responses:
        "102":
          description: Processing
        "200":
          content:
            application/vnd.atlas.2023-01-01+csv:
              schema:
                type: string
              x-xgen-version: 2023-01-01
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CostExplorerQueryResult'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: "Return results from a given Cost Explorer query, or notify that the\
        \ results are not ready yet."
      tags:
      - Invoices
  /api/atlas/v2/orgs/{orgId}/events:
    get:
      description: |-
        Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.

        This resource remains under revision and may change.
      operationId: listOrganizationEvents
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: |-
          Category of incident recorded at this moment in time.

          **IMPORTANT**: The complete list of event type values changes frequently.
        in: query
        name: eventType
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EventTypeForOrg'
      - description: Flag that indicates whether to include the raw document in the
          output. The raw document contains additional meta information about the
          event.
        in: query
        name: includeRaw
        schema:
          type: boolean
          default: false
      - description: Date and time from when MongoDB Cloud stops returning events.
          This parameter uses the <a href="https://en.wikipedia.org/wiki/ISO_8601"
          target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
          in UTC.
        in: query
        name: maxDate
        schema:
          type: string
          format: date-time
      - description: Date and time from when MongoDB Cloud starts returning events.
          This parameter uses the <a href="https://en.wikipedia.org/wiki/ISO_8601"
          target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
          in UTC.
        in: query
        name: minDate
        schema:
          type: string
          format: date-time
          example: 2021-11-17T23:15:00.06Z
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrgPaginatedEventView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Events from One Organization
      tags:
      - Events
  /api/atlas/v2/orgs/{orgId}/events/{eventId}:
    get:
      description: |-
        Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.

        This resource remains under revision and may change.
      operationId: getOrganizationEvent
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: "Unique 24-hexadecimal digit string that identifies the event\
          \ that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents)\
          \ endpoint to retrieve all events to which the authenticated user has access."
        in: path
        name: eventId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Flag that indicates whether to include the raw document in the
          output. The raw document contains additional meta information about the
          event.
        in: query
        name: includeRaw
        schema:
          type: boolean
          default: false
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/EventViewForOrg'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Event from One Organization
      tags:
      - Events
  /api/atlas/v2/orgs/{orgId}/federationSettings:
    get:
      description: "Returns information about the federation settings for the specified\
        \ organization. To use this resource, the requesting API Key must have the\
        \ Organization Owner role in the connected org."
      operationId: getFederationSettings
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrgFederationSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Federation Settings for One Organization
      tags:
      - Federated Authentication
  /api/atlas/v2/orgs/{orgId}/groups:
    get:
      description: |-
        Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:

        - Isolate different environments, such as development, test, or production environments, from each other.
        - Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.
        - Maintain separate cluster security configurations.
        - Create different alert settings.

        To use this resource, the requesting API Key must have the Organization Member role.
      operationId: listOrganizationProjects
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: Human-readable label of the project to use to filter the returned
          list. Performs a case-insensitive search for a project within the organization
          which is prefixed by the specified name.
        in: query
        name: name
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAtlasGroupView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One or More Projects in One Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/invites:
    get:
      description: "Returns all pending invitations to the specified organization.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Owner role."
      operationId: listOrganizationInvitations
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: "Email address of the user account invited to this organization.\
          \ If you exclude this parameter, this resource returns all pending invitations."
        in: query
        name: username
        schema:
          type: string
          format: email
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrganizationInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Organization Invitations
      tags:
      - Organizations
    patch:
      description: "Updates the details of one pending invitation to the specified\
        \ organization. To specify which invitation, provide the username of the invited\
        \ user. To use this resource, the requesting API Key must have the Organization\
        \ Owner role."
      operationId: updateOrganizationInvitation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/OrganizationInvitationRequest'
        description: Updates the details of one pending invitation to the specified
          organization.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Organization Invitation
      tags:
      - Organizations
    post:
      description: "Invites one MongoDB Cloud user to join the specified organization.\
        \ The user must accept the invitation to access information within the specified\
        \ organization. To use this resource, the requesting API Key must have the\
        \ Organization Owner role."
      operationId: createOrganizationInvitation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/OrganizationInvitationRequest'
        description: Invites one MongoDB Cloud user to join the specified organization.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Invite One MongoDB Cloud User to Join One Atlas Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/invites/{invitationId}:
    delete:
      description: "Cancels one pending invitation sent to the specified MongoDB Cloud\
        \ user to join an organization. You can't cancel an invitation that the user\
        \ accepted. To use this resource, the requesting API Key must have the Organization\
        \ Owner role."
      operationId: deleteOrganizationInvitation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the invitation.
        in: path
        name: invitationId
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Cancel One Organization Invitation
      tags:
      - Organizations
    get:
      description: "Returns the details of one pending invitation to the specified\
        \ organization. To use this resource, the requesting API Key must have the\
        \ Organization Owner role."
      operationId: getOrganizationInvitation
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - description: Unique 24-hexadecimal digit string that identifies the invitation.
        in: path
        name: invitationId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Organization Invitation
      tags:
      - Organizations
    patch:
      description: "Updates the details of one pending invitation to the specified\
        \ organization. To specify which invitation, provide the unique identification\
        \ string for that invitation. Use the Return All Organization Invitations\
        \ endpoint to retrieve IDs for all pending organization invitations. To use\
        \ this resource, the requesting API Key must have the Organization Owner role."
      operationId: updateOrganizationInvitationById
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the invitation.
        in: path
        name: invitationId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/OrganizationInvitationUpdateRequest'
        description: Updates the details of one pending invitation to the specified
          organization.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationInvitation'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update One Organization Invitation by Invitation ID
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/invoices:
    get:
      description: "Returns all invoices that MongoDB issued to the specified organization.\
        \ This list includes all invoices regardless of invoice status. To use this\
        \ resource, the requesting API Key must have the Organization Billing Viewer,\
        \ Organization Billing Admin, or Organization Owner role. If you have a cross-organization\
        \ setup, you can view linked invoices if you have the Organization Billing\
        \ Admin or Organization Owner role."
      operationId: listInvoices
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiInvoiceView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Invoices for One Organization
      tags:
      - Invoices
  /api/atlas/v2/orgs/{orgId}/invoices/pending:
    get:
      description: "Returns all invoices accruing charges for the current billing\
        \ cycle for the specified organization. To use this resource, the requesting\
        \ API Key must have the Organization Billing Viewer, Organization Billing\
        \ Admin, or Organization Owner role. If you have a cross-organization setup,\
        \ you can view linked invoices if you have the Organization Billing Admin\
        \ or Organization Owner Role."
      operationId: listPendingInvoices
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiInvoiceView'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Pending Invoices for One Organization
      tags:
      - Invoices
  /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}:
    get:
      description: "Returns one invoice that MongoDB issued to the specified organization.\
        \ A unique 24-hexadecimal digit string identifies the invoice. You can choose\
        \ to receive this invoice in JSON or CSV format. To use this resource, the\
        \ requesting API Key must have the Organization Billing Viewer, Organization\
        \ Billing Admin, or Organization Owner role. If you have a cross-organization\
        \ setup, you can query for a linked invoice if you have the Organization Billing\
        \ Admin or Organization Owner role."
      operationId: getInvoice
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the invoice
          submitted to the specified organization. Charges typically post the next
          day.
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+csv:
              schema:
                type: string
              x-xgen-version: 2023-01-01
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/BillingInvoice'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Organization Invoice
      tags:
      - Invoices
  /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv:
    get:
      description: "Returns one invoice that MongoDB issued to the specified organization\
        \ in CSV format. A unique 24-hexadecimal digit string identifies the invoice.\
        \ To use this resource, the requesting API Key have at least the Organization\
        \ Billing Viewer, Organization Billing Admin, or Organization Owner role.\
        \ If you have a cross-organization setup, you can query for a linked invoice\
        \ if you have the Organization Billing Admin or Organization Owner Role."
      operationId: downloadInvoiceCSV
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the invoice
          submitted to the specified organization. Charges typically post the next
          day.
        in: path
        name: invoiceId
        required: true
        schema:
          type: string
          pattern: "[0-9a-f]+"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+csv:
              schema:
                type: string
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Organization Invoice as CSV
      tags:
      - Invoices
  /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects:
    get:
      description: Return all projects that you can migrate to the specified organization.
      operationId: listSourceProjects
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LiveImportAvailableProject'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Projects Available for Migration
      tags:
      - Cloud Migration Service
  /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens:
    delete:
      description: Remove one organization link and its associated public API key.
        MongoDB Atlas uses the link-token for push live migrations only. Live migrations
        (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB
        Atlas. Your API Key must have the Organization Owner role to successfully
        call this resource.
      operationId: deleteLinkToken
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Link-Token
      tags:
      - Cloud Migration Service
    post:
      description: Create one link-token that contains all the information required
        to complete the link. MongoDB Atlas uses the link-token for push live migrations
        only. Live migration (push) allows you to securely push data from Cloud Manager
        or Ops Manager into MongoDB Atlas. Your API Key must have the Organization
        Owner role to successfully call this resource.
      operationId: createLinkToken
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/TargetOrgRequest'
        description: IP address access list entries associated with the migration.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TargetOrg'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Link-Token
      tags:
      - Cloud Migration Service
  /api/atlas/v2/orgs/{orgId}/serviceAccounts:
    get:
      description: Returns list of Service Accounts with service account details.
      operationId: listServiceAccounts
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedOrgServiceAccounts'
              x-xgen-version: 2023-10-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      - serviceAccounts: []
      summary: Return All Service Accounts
      tags:
      - Organizations
    post:
      description: Create Service Account containing client id and client secrets.
      operationId: createServiceAccount
      parameters:
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              $ref: '#/components/schemas/OrgServiceAccountRequest'
        description: Details to create service account in the specified organization.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/OrgServiceAccount'
              x-xgen-version: 2023-10-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Creation
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}:
    delete:
      description: Delete Service Account.
      operationId: deleteServiceAccount
      parameters:
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-10-01+json:
              x-xgen-version: 2023-10-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Deletion.
      tags:
      - Organizations
    get:
      description: Get Service Account Details.
      operationId: getServiceAccount
      parameters:
      - $ref: '#/components/parameters/orgId'
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/OrgServiceAccountDetails'
              x-xgen-version: 2023-10-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Fetching
      tags:
      - Organizations
    patch:
      description: Update Service Account.
      operationId: updateServiceAccount
      parameters:
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              $ref: '#/components/schemas/OrgServiceAccountUpdateRequest'
        description: Details to update service account in the specified organization.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/OrgServiceAccountDetails'
              x-xgen-version: 2023-10-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Update
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups:
    get:
      description: Returns list of Service Account projects.
      operationId: listServiceAccountProjects
      parameters:
      - $ref: '#/components/parameters/orgId'
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedServiceAccountGroup'
              x-xgen-version: 2023-10-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Service Account projects
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets:
    post:
      description: Create Service Account secret.
      operationId: createServiceAccountSecret
      parameters:
      - $ref: '#/components/parameters/orgId'
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-10-01+json:
            schema:
              $ref: '#/components/schemas/ServiceAccountSecretRequest'
        description: Details to create secret in the specified service account.
        required: true
      responses:
        "201":
          content:
            application/vnd.atlas.2023-10-01+json:
              schema:
                $ref: '#/components/schemas/ServiceAccountSecret'
              x-xgen-version: 2023-10-01
          description: Created
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Secret Creation
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}:
    delete:
      description: Delete Service Account Secret.
      operationId: deleteServiceAccountSecret
      parameters:
      - description: Id of the service account.
        in: path
        name: serviceAccountId
        required: true
        schema:
          type: string
      - description: Id of the secret.
        in: path
        name: secretId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      responses:
        "204":
          content:
            application/vnd.atlas.2023-10-01+json:
              x-xgen-version: 2023-10-01
          description: This endpoint does not return a response body.
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Service Account Secret Deletion.
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/settings:
    get:
      description: "Returns details about the specified organization's settings. To\
        \ use this resource, the requesting API Key must have the Organization Owner\
        \ role."
      operationId: getOrganizationSettings
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return Settings for One Organization
      tags:
      - Organizations
    patch:
      description: "Updates the organization's settings. To use this resource, the\
        \ requesting API Key must have the Organization Owner role."
      operationId: updateOrganizationSettings
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/OrganizationSettings'
        description: Details to update on the specified organization's settings.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/OrganizationSettings'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Settings for One Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/teams:
    get:
      description: "Returns all teams that belong to the specified organization. Teams\
        \ enable you to grant project access roles to MongoDB Cloud users. MongoDB\
        \ Cloud only returns teams for which you have access. To use this resource,\
        \ the requesting API Key must have the Organization Member role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: listOrganizationTeams
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All Teams in One Organization
      tags:
      - Teams
    post:
      description: "Creates one team in the specified organization. Teams enable you\
        \ to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits\
        \ the number of teams to a maximum of 250 teams per organization. To use this\
        \ resource, the requesting API Key must have the Organization Owner role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: createTeam
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/Team'
        description: Team that you want to create in the specified organization.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/Team'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One Team in One Organization
      tags:
      - Teams
  /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}:
    get:
      description: "Returns one team that you identified using its human-readable\
        \ name. This team belongs to one organization. Teams enable you to grant project\
        \ access roles to MongoDB Cloud users. To use this resource, the requesting\
        \ API Key must have the Organization Member role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: getTeamByName
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Name of the team whose information you want to return.
        in: path
        name: teamName
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TeamResponse'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Team using its Name
      tags:
      - Teams
  /api/atlas/v2/orgs/{orgId}/teams/{teamId}:
    delete:
      description: "Removes one team specified using its unique 24-hexadecimal digit\
        \ identifier from the organization specified using its unique 24-hexadecimal\
        \ digit identifier. To use this resource, the requesting API Key must have\
        \ the Organization Owner role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: deleteTeam
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the team that
          you want to delete.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One Team from One Organization
      tags:
      - Teams
    get:
      description: "Returns one team that you identified using its unique 24-hexadecimal\
        \ digit ID. This team belongs to one organization. Teams enable you to grant\
        \ project access roles to MongoDB Cloud users. To use this resource, the requesting\
        \ API Key must have the Organization Member role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: getTeamById
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the team whose
          information you want to return.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TeamResponse'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One Team using its ID
      tags:
      - Teams
    patch:
      description: "Renames one team in the specified organization. Teams enable you\
        \ to grant project access roles to MongoDB Cloud users. To use this resource,\
        \ the requesting API Key must have the Organization Owner role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: renameTeam
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the team that
          you want to rename.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/TeamUpdate'
        description: Details to update on the specified team.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/TeamResponse'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Rename One Team
      tags:
      - Teams
  /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users:
    get:
      description: "Returns all MongoDB Cloud users assigned to the team specified\
        \ using its unique 24-hexadecimal digit identifier. This team belongs to one\
        \ organization. Teams enable you to grant project access roles to MongoDB\
        \ Cloud users. To use this resource, the requesting API Key must have the\
        \ Organization Member role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: listTeamUsers
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pageNum'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the team whose
          application users you want to return.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAppUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All MongoDB Cloud Users Assigned to One Team
      tags:
      - Teams
    post:
      description: "Adds one or more MongoDB Cloud users from the specified organization\
        \ to the specified team. Teams enable you to grant project access roles to\
        \ MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one\
        \ organization to one team. To use this resource, the requesting API Key must\
        \ have the Organization Owner role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: addTeamUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal character string that identifies the team
          to which you want to add MongoDB Cloud users.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AddUserToTeam'
        description: One or more MongoDB Cloud users that you want to add to the specified
          team.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedApiAppUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "409":
          $ref: '#/components/responses/conflict'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Assign MongoDB Cloud Users from One Organization to One Team
      tags:
      - Teams
  /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}:
    delete:
      description: "Removes one MongoDB Cloud user from the specified team. This team\
        \ belongs to one organization. Teams enable you to grant project access roles\
        \ to MongoDB Cloud users. To use this resource, the requesting API Key must\
        \ have the Organization Owner role."
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: removeTeamUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies the team from
          which you want to remove one database application user.
        in: path
        name: teamId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - description: Unique 24-hexadecimal digit string that identifies MongoDB Cloud
          user that you want to remove from the specified team.
        in: path
        name: userId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One MongoDB Cloud User from One Team
      tags:
      - Teams
  /api/atlas/v2/orgs/{orgId}/users:
    get:
      description: "Returns details about the MongoDB Cloud users associated with\
        \ the specified organization. Each MongoDB Cloud user returned must belong\
        \ to the specified organization or to a project within the specified organization.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ Member role."
      operationId: listOrganizationUsers
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/includeCount'
      - $ref: '#/components/parameters/itemsPerPage'
      - $ref: '#/components/parameters/pageNum'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/PaginatedAppUserView'
              x-xgen-version: 2023-01-01
          description: OK
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return All MongoDB Cloud Users in One Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/users/{userId}:
    delete:
      description: "Removes one MongoDB Cloud user from the specified organization.\
        \ To use this resource, the requesting API Key must have the Organization\
        \ User Admin role."
      operationId: removeOrganizationUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/orgId'
      - description: Unique 24-hexadecimal digit string that identifies the user to
          be deleted.
        in: path
        name: userId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "204":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/NoBody'
              x-xgen-version: 2023-01-01
          description: This endpoint does not return a response body.
        "400":
          $ref: '#/components/responses/badRequest'
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Remove One MongoDB Cloud User from One Organization
      tags:
      - Organizations
  /api/atlas/v2/orgs/{orgId}/users/{userId}/roles:
    put:
      description: "Updates the roles of the specified user in the specified organization.\
        \ To specify the user to update, provide the unique 24-hexadecimal digit string\
        \ that identifies the user in the specified organization. To use this resource,\
        \ the requesting API Key must have the Organization User Admin role."
      operationId: updateOrganizationRoles
      parameters:
      - $ref: '#/components/parameters/orgId'
      - description: Unique 24-hexadecimal digit string that identifies the user to
          modify.
        in: path
        name: userId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/envelope'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/UpdateOrgRolesForUser'
        description: Roles to update for the specified user.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/UpdateOrgRolesForUser'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "403":
          $ref: '#/components/responses/forbidden'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Update Organization Roles for One MongoDB Cloud User
      tags:
      - Organizations
  /api/atlas/v2/unauth/controlPlaneIPAddresses:
    get:
      description: Returns all control plane IP addresses.
      operationId: returnAllControlPlaneIPAddresses
      parameters:
      - $ref: '#/components/parameters/envelope'
      responses:
        "200":
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                $ref: '#/components/schemas/ControlPlaneIPAddresses'
              x-xgen-version: 2023-11-15
          description: OK
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - Unauthenticated: []
      summary: Return All Control Plane IP Addresses
      tags:
      - Root
  /api/atlas/v2/users:
    post:
      description: |-
        Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.

         MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.

         To use this resource, the requesting API Key can have any role.
      operationId: createUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              $ref: '#/components/schemas/CloudAppUser'
        description: MongoDB Cloud user account to create.
        required: true
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudAppUser'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Create One MongoDB Cloud User
      tags:
      - MongoDB Cloud Users
  /api/atlas/v2/users/byName/{userName}:
    get:
      description: "Returns the details for one MongoDB Cloud user account with the\
        \ specified username. You can't use this endpoint to return information about\
        \ an API Key. To return information about an API Key, use the [Return One\
        \ Organization](#tag/Organizations/operation/getOrganization) API Key endpoint.\
        \ To use this resource, the requesting API Key can have any role."
      operationId: getUserByUsername
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Email address that belongs to the MongoDB Cloud user account.
          You cannot modify this address after creating the user.
        in: path
        name: userName
        required: true
        schema:
          type: string
          pattern: "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\\
            .)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudAppUser'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One MongoDB Cloud User using Their Username
      tags:
      - MongoDB Cloud Users
  /api/atlas/v2/users/{userId}:
    get:
      description: "Returns the details for one MongoDB Cloud user account with the\
        \ specified unique identifier for the user. You can't use this endpoint to\
        \ return information on an API Key. To return information about an API Key,\
        \ use the [Return One Organization](#tag/Organizations/operation/getOrganization)\
        \ API Key endpoint. You can always retrieve your own user account. If you\
        \ are the owner of a MongoDB Cloud organization or project, you can also retrieve\
        \ the user profile for any user with membership in that organization or project.\
        \ To use this resource, the requesting API Key can have any role."
      operationId: getUser
      parameters:
      - $ref: '#/components/parameters/envelope'
      - $ref: '#/components/parameters/pretty'
      - description: Unique 24-hexadecimal digit string that identifies this user.
        in: path
        name: userId
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      responses:
        "200":
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                $ref: '#/components/schemas/CloudAppUser'
              x-xgen-version: 2023-01-01
          description: OK
        "401":
          $ref: '#/components/responses/unauthorized'
        "404":
          $ref: '#/components/responses/notFound'
        "500":
          $ref: '#/components/responses/internalServerError'
      security:
      - DigestAuth: []
      summary: Return One MongoDB Cloud User using Its ID
      tags:
      - MongoDB Cloud Users
components:
  parameters:
    collectionName:
      description: Human-readable label that identifies the collection.
      in: path
      name: collectionName
      required: true
      schema:
        type: string
        example: mycoll
    databaseName:
      description: Human-readable label that identifies the database.
      in: path
      name: databaseName
      required: true
      schema:
        type: string
        example: mydb
    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
      required: false
      schema:
        type: string
        format: date-time
    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
      required: false
      schema:
        type: boolean
        default: false
        example: false
    federationSettingsId:
      description: Unique 24-hexadecimal digit string that identifies your federation.
      in: path
      name: federationSettingsId
      required: true
      schema:
        type: string
        example: 55fa922fb343282757d9554e
        maxLength: 24
        minLength: 24
        pattern: "^([a-f0-9]{24})$"
    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:
        type: string
        example: PT1M
    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:
        type: string
        example: 32b6e34b3d91647abb20e7b8
        maxLength: 24
        minLength: 24
        pattern: "^([a-f0-9]{24})$"
    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:
        type: string
        example: c2777a9eca931f29fc2f
        maxLength: 20
        minLength: 20
        pattern: "^([a-f0-9]{20})$"
    includeCount:
      description: Flag that indicates whether the response returns the total number
        of items (**totalCount**) in the response.
      in: query
      name: includeCount
      required: false
      schema:
        type: boolean
        default: true
        example: true
    indexName:
      description: Human-readable label that identifies the index.
      in: path
      name: indexName
      required: true
      schema:
        type: string
        example: myindex
    itemsPerPage:
      description: Number of items that the response returns per page.
      in: query
      name: itemsPerPage
      required: false
      schema:
        type: integer
        default: 100
        example: 100
        maximum: 500
        minimum: 1
    liveMigrationId:
      description: Unique 24-hexadecimal digit string that identifies the migration.
      in: path
      name: liveMigrationId
      required: true
      schema:
        type: string
        example: 6296fb4c7c7aa997cf94e9a8
        maxLength: 24
        minLength: 24
        pattern: "^([a-f0-9]{24})$"
    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:
        type: string
        example: 4888442a3354817a7320eb61
        maxLength: 24
        minLength: 24
        pattern: "^([a-f0-9]{24})$"
    pageNum:
      description: Number of the page that displays the current set of the total objects
        that the response returns.
      in: query
      name: pageNum
      required: false
      schema:
        type: integer
        default: 1
        example: 1
        minimum: 1
    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
      required: false
      schema:
        type: string
        example: PT10H
    pretty:
      description: Flag that indicates whether the response body should be in the
        <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener
        noreferrer">prettyprint</a> format.
      in: query
      name: pretty
      required: false
      schema:
        type: boolean
        default: false
        example: false
    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:
        type: string
        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})$"
    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
      required: false
      schema:
        type: string
        format: date-time
  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.
    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:
    AWSCloudProviderContainer:
      type: object
      allOf:
      - $ref: '#/components/schemas/CloudProviderContainer'
      - type: object
        properties:
          atlasCidrBlock:
            type: string
            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})+$"
          regionName:
            type: string
            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_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - 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
            - GLOBAL
            - US_GOV_WEST_1
            - US_GOV_EAST_1
          vpcId:
            type: string
            description: Unique string that identifies the MongoDB Cloud VPC on AWS.
            example: vpc-b555d3b0d9cb783b0
            minLength: 5
            pattern: "^vpc-[0-9a-f]{17}$"
            readOnly: true
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      required:
      - regionName
      title: AWS
    AWSCloudProviderSettings:
      type: object
      allOf:
      - $ref: '#/components/schemas/ClusterProviderSettings'
      - type: object
        properties:
          autoScaling:
            $ref: '#/components/schemas/CloudProviderAWSAutoScaling'
          diskIOPS:
            type: integer
            format: int32
            description: Maximum Disk Input/Output Operations per Second (IOPS) that
              the database host can perform.
          encryptEBSVolume:
            type: boolean
            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.
          instanceSizeName:
            type: string
            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
          regionName:
            type: string
            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_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - 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
            - GLOBAL
            externalDocs:
              description: AWS
              url: https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws
            title: AWS Regions
          volumeType:
            type: string
            description: "Disk Input/Output Operations per Second (IOPS) setting for\
              \ Amazon Web Services (AWS) storage that you configure only for abbr\
              \ title=\"Amazon Web Services\">AWS</abbr>. 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
    AWSComputeAutoScaling:
      type: object
      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:
          type: string
          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
        minInstanceSize:
          type: string
          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
      title: AWS
    AWSCreateDataProcessRegionView:
      type: object
      allOf:
      - $ref: '#/components/schemas/CreateDataProcessRegionView'
      - type: object
        properties:
          region:
            type: string
            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
    AWSCustomDNSEnabledView:
      type: object
      properties:
        enabled:
          type: boolean
          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-
      required:
      - enabled
    AWSDataProcessRegionView:
      type: object
      allOf:
      - $ref: '#/components/schemas/DataProcessRegionView'
      - type: object
        properties:
          region:
            type: string
            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
            readOnly: true
    AWSHardwareSpec:
      type: object
      description: Hardware specifications for nodes deployed in the region.
      properties:
        diskIOPS:
          type: integer
          format: int32
          description: |-
            Target throughput desired for storage attached to your AWS-provisioned cluster. Change this parameter only if you:

            - set `"replicationSpecs[n].regionConfigs[m].providerName" : "AWS"`.
            - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M30"` 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.
            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.
        ebsVolumeType:
          type: string
          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
        instanceSize:
          type: string
          description: Hardware specification for the instance sizes in this region.
            Each instance size has a default storage and memory capacity. The instance
            size you select applies to all the data-bearing hosts in your instance
            size.
          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
        nodeCount:
          type: integer
          format: int32
          description: Number of nodes of the given type for MongoDB Cloud to deploy
            to the region.
      title: AWS Cluster Hardware Settings
    AWSInterfaceEndpoint:
      type: object
      description: Group of Private Endpoint settings.
      properties:
        cloudProvider:
          type: string
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
        connectionStatus:
          type: string
          description: State of the Amazon Web Service PrivateLink connection when
            MongoDB Cloud received this request.
          enum:
          - PENDING_ACCEPTANCE
          - PENDING
          - AVAILABLE
          - REJECTED
          - DELETING
          readOnly: true
        deleteRequested:
          type: boolean
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
        errorMessage:
          type: string
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
        interfaceEndpointId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the interface
            endpoint.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
      required:
      - cloudProvider
      title: AWS
    AWSKMSConfiguration:
      type: object
      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:
          type: string
          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
        customerMasterKeyID:
          type: string
          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
        enabled:
          type: boolean
          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`."
        region:
          type: string
          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_NORTHEAST_1
          - AP_NORTHEAST_2
          - AP_NORTHEAST_3
          - AP_SOUTHEAST_1
          - AP_SOUTHEAST_2
          - AP_SOUTHEAST_3
          - AP_SOUTHEAST_4
          - 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
          - GLOBAL
          title: AWS Regions
        roleId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies an Amazon
            Web Services (AWS) Identity and Access Management (IAM) role. This IAM
            role has the permissions required to manage your AWS customer master key.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          writeOnly: true
        secretAccessKey:
          type: string
          description: Human-readable label of the Identity and Access Management
            (IAM) secret access key with permissions required to access your Amazon
            Web Services (AWS) customer master key.
          writeOnly: true
        valid:
          type: boolean
          description: Flag that indicates whether the Amazon Web Services (AWS) Key
            Management Service (KMS) encryption key can encrypt and decrypt data.
          readOnly: true
    AWSPrivateLinkConnection:
      type: object
      description: Group of Private Endpoint Service settings.
      properties:
        cloudProvider:
          type: string
          description: Cloud service provider that serves the requested endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
        endpointServiceName:
          type: string
          description: Unique string that identifies the Amazon Web Services (AWS)
            PrivateLink endpoint service. MongoDB Cloud returns null while it creates
            the endpoint service.
          pattern: "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}"
          readOnly: true
        errorMessage:
          type: string
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        interfaceEndpoints:
          type: array
          description: List of strings that identify private endpoint interfaces applied
            to the specified project.
          items:
            type: string
            description: Unique 24-hexadecimal digit string that identifies the interface
              endpoint.
            example: 32b6e34b3d91647abb20e7b8
            maxLength: 24
            minLength: 24
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
          readOnly: true
        regionName:
          type: string
          description: Cloud provider region that manages this Private Endpoint Service.
          readOnly: true
        status:
          type: string
          description: State of the Private Endpoint Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - WAITING_FOR_USER
          - FAILED
          - DELETING
          readOnly: true
      required:
      - cloudProvider
      title: AWS
    AWSRegionConfig:
      type: object
      allOf:
      - $ref: '#/components/schemas/CloudRegionConfig'
      - type: object
        properties:
          analyticsAutoScaling:
            $ref: '#/components/schemas/AdvancedAutoScalingSettings'
          analyticsSpecs:
            $ref: '#/components/schemas/DedicatedHardwareSpec'
          autoScaling:
            $ref: '#/components/schemas/AdvancedAutoScalingSettings'
          readOnlySpecs:
            $ref: '#/components/schemas/DedicatedHardwareSpec'
      description: Details that explain how MongoDB Cloud replicates data in one region
        on the specified MongoDB database.
      title: AWS Regional Replication Specifications
    AccessListItemView:
      type: object
      properties:
        cidrBlock:
          type: string
          description: Range of IP addresses in Classless Inter-Domain Routing (CIDR)
            notation that found in this project's access list.
          pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
          readOnly: true
        ipAddress:
          type: string
          description: IP address included in the API access list.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
      required:
      - ipAddress
    AddUserToTeam:
      type: object
      properties:
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
      required:
      - id
    AdvancedAutoScalingSettings:
      type: object
      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
    AdvancedClusterDescription:
      type: object
      properties:
        acceptDataRisksAndForceReplicaSetReconfig:
          type: string
          format: date-time
          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."
          externalDocs:
            description: Reconfiguring a Replica Set during a regional outage
            url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set
        backupEnabled:
          type: boolean
          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](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/)\
            \ 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."
        biConnector:
          $ref: '#/components/schemas/BiConnector'
        clusterType:
          type: string
          description: Configuration of nodes that comprise the cluster.
          enum:
          - REPLICASET
          - SHARDED
          - GEOSHARDED
        connectionStrings:
          $ref: '#/components/schemas/ClusterConnectionStrings'
        createDate:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created this cluster. This
            parameter expresses its value in ISO 8601 format in UTC.
          readOnly: true
        diskSizeGB:
          type: number
          format: double
          description: "Storage capacity that the host's root volume possesses expressed\
            \ in gigabytes. Increase this number to add capacity. MongoDB Cloud requires\
            \ this parameter if you set **replicationSpecs**. If you specify a disk\
            \ size below the minimum (10 GB), this parameter defaults to the minimum\
            \ disk size value. Storage charge calculations depend on whether you choose\
            \ the default value or a custom value.  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."
          maximum: 4096
          minimum: 10
        diskWarmingMode:
          type: string
          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
        encryptionAtRestProvider:
          type: string
          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/
        groupId:
          type: string
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          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
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        labels:
          type: array
          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](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.
          items:
            $ref: '#/components/schemas/ComponentLabel'
        links:
          type: array
          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
        mongoDBMajorVersion:
          type: string
          default: "7.0"
          description: Major MongoDB version of the cluster. MongoDB Cloud deploys
            the cluster with the latest stable release of the specified version.
          enum:
          - "4.2"
          - "4.4"
          - "5.0"
          - "6.0"
          - "7.0"
        mongoDBVersion:
          type: string
          description: Version of MongoDB that the cluster runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
        name:
          type: string
          description: Human-readable label that identifies the advanced cluster.
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
        paused:
          type: boolean
          description: Flag that indicates whether the cluster is paused.
        pitEnabled:
          type: boolean
          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/
        replicationSpecs:
          type: array
          description: "List of settings that configure your cluster regions. For\
            \ Global Clusters, each object in the array represents a zone where your\
            \ clusters nodes deploy. For non-Global sharded clusters and replica sets,\
            \ this array has one object representing where your clusters nodes deploy."
          items:
            $ref: '#/components/schemas/ReplicationSpec'
        rootCertType:
          type: string
          default: ISRGROOTX1
          description: Root Certificate Authority that MongoDB Cloud cluster uses.
            MongoDB Cloud supports Internet Security Research Group.
          enum:
          - ISRGROOTX1
        stateName:
          type: string
          description: Human-readable label that indicates the current operating condition
            of this cluster.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
        tags:
          type: array
          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'
        terminationProtectionEnabled:
          type: boolean
          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."
        versionReleaseSystem:
          type: string
          default: LTS
          description: "Method by which the cluster maintains the MongoDB versions.\
            \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**."
          enum:
          - LTS
          - CONTINUOUS
    AdvancedComputeAutoScaling:
      type: object
      description: Options that determine how this cluster handles CPU scaling.
      properties:
        enabled:
          type: boolean
          description: |-
            Flag that indicates whether someone enabled instance size auto-scaling.

            - Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.
            - Set to `false` to disable instance size automatic scaling.
        maxInstanceSize:
          $ref: '#/components/schemas/BaseCloudProviderInstanceSize'
        minInstanceSize:
          $ref: '#/components/schemas/BaseCloudProviderInstanceSize'
        scaleDownEnabled:
          type: boolean
          description: "Flag that indicates whether the instance size may scale down.\
            \ MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\"\
            \ : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**."
      title: Automatic Compute Scaling Settings
    AdvancedDiskBackupSnapshotSchedulePolicy:
      type: object
      description: List that contains a document for each backup policy item in the
        desired backup policy.
      properties:
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy.
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        policyItems:
          type: array
          description: List that contains the specifications for one policy.
          items:
            $ref: '#/components/schemas/DiskBackupApiPolicyItem'
    AlertAudit:
      type: object
      description: Alert audit indicates acknowledgement status of an alert.
      properties:
        alertId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the alert
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/AlertAuditTypeView'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: Alert Audits
    AlertAuditTypeView:
      type: string
      description: Unique identifier of event type.
      enum:
      - ALERT_ACKNOWLEDGED_AUDIT
      - ALERT_UNACKNOWLEDGED_AUDIT
      example: ALERT_ACKNOWLEDGED_AUDIT
      title: Alert Audit Types
    AlertConfigAudit:
      type: object
      description: Alert config audit indicates any activities around alert settings.
      properties:
        alertConfigId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration associated with the **alertId**.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/AlertConfigAuditTypeView'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: Alert Config Audits
    AlertConfigAuditTypeView:
      type: string
      description: Unique identifier of event type.
      enum:
      - ALERT_CONFIG_DISABLED_AUDIT
      - ALERT_CONFIG_ENABLED_AUDIT
      - ALERT_CONFIG_ADDED_AUDIT
      - ALERT_CONFIG_DELETED_AUDIT
      - ALERT_CONFIG_CHANGED_AUDIT
      example: ALERT_CONFIG_ADDED_AUDIT
      title: Alert Audit Types
    AlertConfigView:
      type: object
      description: Alert settings allows to select which conditions trigger alerts
        and how users are notified.
      properties:
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
        enabled:
          type: boolean
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
        eventTypeName:
          type: string
          description: Event type name.
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        matchers:
          type: array
          description: No matchers are available for these alert types. The list is
            always empty.
          items:
            type: object
          readOnly: true
        notifications:
          type: array
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            $ref: '#/components/schemas/AlertsNotificationBase'
        updated:
          type: string
          format: date-time
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
      required:
      - notifications
      title: Alert Configuration
    AlertView:
      type: object
      description: "Alert represents a notice of warning, a threat or a problem in\
        \ the system. It can reflect a certain event or condition in the system. An\
        \ Alert can be acknowledged by the user, but stays open until alert condition\
        \ is resolved in the system."
      properties:
        acknowledgedUntil:
          type: string
          format: date-time
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

            - To acknowledge this alert forever, set the parameter value to 100 years in the future.

            - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past.
        acknowledgementComment:
          type: string
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
        acknowledgingUsername:
          type: string
          format: email
          description: MongoDB Cloud username of the person who acknowledged the alert.
            The response returns this parameter if a MongoDB Cloud user previously
            acknowledged this alert.
          readOnly: true
        alertConfigId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        lastNotified:
          type: string
          format: date-time
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        resolved:
          type: string
          format: date-time
          description: "Date and time that this alert changed to `\"status\" : \"\
            CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\"\
            \ target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp\
            \ format in UTC. The resource returns this parameter once `\"status\"\
            \ : \"CLOSED\"`."
          readOnly: true
        status:
          type: string
          description: State of this alert at the time you requested its details.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
        updated:
          type: string
          format: date-time
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
      required:
      - acknowledgedUntil
      - alertConfigId
      - created
      - id
      - status
      - updated
      title: Alert
    AlertViewForNdsGroup:
      type: object
      oneOf:
      - $ref: '#/components/schemas/AppServiceAlertView'
      - $ref: '#/components/schemas/ClusterAlertView'
      - $ref: '#/components/schemas/HostAlertViewForNdsGroup'
      - $ref: '#/components/schemas/HostMetricAlert'
      - $ref: '#/components/schemas/ReplicaSetAlertViewForNdsGroup'
      - $ref: '#/components/schemas/DefaultAlertViewForNdsGroup'
    AlertsNotificationBase:
      type: object
      description: One target that MongoDB Cloud sends notifications when an alert
        triggers.
      oneOf:
      - $ref: '#/components/schemas/DatadogNotification'
      - $ref: '#/components/schemas/EmailNotification'
      - $ref: '#/components/schemas/GroupNotification'
      - $ref: '#/components/schemas/HipChatNotification'
      - $ref: '#/components/schemas/MicrosoftTeamsNotification'
      - $ref: '#/components/schemas/NDSNotificationView'
      - $ref: '#/components/schemas/OpsGenieNotification'
      - $ref: '#/components/schemas/OrgNotification'
      - $ref: '#/components/schemas/PagerDutyNotification'
      - $ref: '#/components/schemas/SlackNotification'
      - $ref: '#/components/schemas/SMSNotification'
      - $ref: '#/components/schemas/SummaryNotification'
      - $ref: '#/components/schemas/TeamNotification'
      - $ref: '#/components/schemas/UserNotification'
      - $ref: '#/components/schemas/VictorOpsNotification'
      - $ref: '#/components/schemas/WebhookNotification'
    AlertsNotificationRootForGroup:
      type: object
      description: One target that MongoDB Cloud sends notifications when an alert
        triggers.
      oneOf:
      - $ref: '#/components/schemas/DatadogNotification'
      - $ref: '#/components/schemas/EmailNotification'
      - $ref: '#/components/schemas/GroupNotification'
      - $ref: '#/components/schemas/HipChatNotification'
      - $ref: '#/components/schemas/MicrosoftTeamsNotification'
      - $ref: '#/components/schemas/OpsGenieNotification'
      - $ref: '#/components/schemas/OrgNotification'
      - $ref: '#/components/schemas/PagerDutyNotification'
      - $ref: '#/components/schemas/SlackNotification'
      - $ref: '#/components/schemas/SMSNotification'
      - $ref: '#/components/schemas/TeamNotification'
      - $ref: '#/components/schemas/UserNotification'
      - $ref: '#/components/schemas/VictorOpsNotification'
      - $ref: '#/components/schemas/WebhookNotification'
    AlertsThresholdInteger:
      type: object
      description: A Limit that triggers an alert when  exceeded. The resource returns
        this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.
      properties:
        operator:
          $ref: '#/components/schemas/Operator'
        threshold:
          type: integer
          format: int32
          description: "Value of metric that, when exceeded, triggers an alert."
        units:
          type: string
          description: "Element used to express the quantity. This can be an element\
            \ of time, storage capacity, and the like."
          enum:
          - bits
          - Kbits
          - Mbits
          - Gbits
          - bytes
          - KB
          - MB
          - GB
          - TB
          - PB
          - nsec
          - msec
          - sec
          - min
          - hours
          - million minutes
          - days
          - requests
          - 1000 requests
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          - ""
          - ""
          - ""
      title: Threshold
    AlertsToggle:
      type: object
      description: Enables or disables the specified alert configuration in the specified
        project.
      properties:
        enabled:
          type: boolean
          description: Flag that indicates whether to enable or disable the specified
            alert configuration in the specified project.
      title: Toggle Request
    ApiAtlasCheckpointView:
      type: object
      properties:
        clusterId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the cluster
            that contains the checkpoint.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        completed:
          type: string
          format: date-time
          description: Date and time when the checkpoint completed and the balancer
            restarted. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns the checkpoints.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies checkpoint.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        parts:
          type: array
          description: |-
            Metadata that describes the complete snapshot.

            - For a replica set, this array contains a single document.
            - For a sharded cluster, this array contains one document for each shard plus one document for the config host.
          items:
            $ref: '#/components/schemas/ApiCheckpointPartView'
          readOnly: true
        restorable:
          type: boolean
          description: Flag that indicates whether MongoDB Cloud can use the checkpoint
            for a restore.
          readOnly: true
        started:
          type: string
          format: date-time
          description: Date and time when the balancer stopped and began the checkpoint.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          readOnly: true
        timestamp:
          type: string
          format: date-time
          description: Date and time to which the checkpoint restores. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          readOnly: true
    ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView:
      type: object
      description: Object that contains the identifying characteristics of the Amazon
        Web Services (AWS) Key Management Service (KMS). This field always returns
        a null value.
      nullable: true
    ApiAtlasDataLakeAWSRegionView:
      type: string
      description: Atlas Data Lake AWS Regions.
      enum:
      - SYDNEY_AUS
      - MUMBAI_IND
      - FRANKFURT_DEU
      - DUBLIN_IRL
      - LONDON_GBR
      - VIRGINIA_USA
      - OREGON_USA
      - SAOPAULO_BRA
      - SINGAPORE_SGP
    ApiAtlasDataLakeAzureRegionView:
      type: string
      description: Atlas Data Lake Azure Regions.
      enum:
      - VIRGINIA_USA
      - CALIFORNIA_USA
      - SINGAPORE_SGP
      - DUBLIN_IRL
      - AMSTERDAM_NLD
      - SYDNEY_AUS
    ApiAtlasFTSAnalyzersViewManual:
      type: object
      description: Settings that describe one Atlas Search custom analyzer.
      properties:
        charFilters:
          type: array
          description: Filters that examine text one character at a time and perform
            filtering operations.
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/charFilterhtmlStrip'
            - $ref: '#/components/schemas/charFiltericuNormalize'
            - $ref: '#/components/schemas/charFiltermapping'
            - $ref: '#/components/schemas/charFilterpersian'
        name:
          type: string
          description: |-
            Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:
            - `lucene.`
            - `builtin.`
            - `mongodb.`
        tokenFilters:
          type: array
          description: |-
            Filter that performs operations such as:

            - Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".

            - Redaction, the removal of sensitive information from public documents.
          items:
            anyOf:
            - $ref: '#/components/schemas/tokenFilterasciiFolding'
            - $ref: '#/components/schemas/tokenFilterdaitchMokotoffSoundex'
            - $ref: '#/components/schemas/tokenFilteredgeGram'
            - $ref: '#/components/schemas/tokenFiltericuFolding'
            - $ref: '#/components/schemas/tokenFiltericuNormalizer'
            - $ref: '#/components/schemas/tokenFilterlength'
            - $ref: '#/components/schemas/tokenFilterlowercase'
            - $ref: '#/components/schemas/tokenFilternGram'
            - $ref: '#/components/schemas/tokenFilterregex'
            - $ref: '#/components/schemas/tokenFilterreverse'
            - $ref: '#/components/schemas/tokenFiltershingle'
            - $ref: '#/components/schemas/tokenFiltersnowballStemming'
            - $ref: '#/components/schemas/tokenFilterstopword'
            - $ref: '#/components/schemas/tokenFiltertrim'
        tokenizer:
          type: object
          description: Tokenizer that you want to use to create tokens. Tokens determine
            how Atlas Search splits up text into discrete chunks for indexing.
          discriminator:
            mapping:
              edgeGram: '#/components/schemas/tokenizeredgeGram'
              keyword: '#/components/schemas/tokenizerkeyword'
              nGram: '#/components/schemas/tokenizernGram'
              regexCaptureGroup: '#/components/schemas/tokenizerregexCaptureGroup'
              regexSplit: '#/components/schemas/tokenizerregexSplit'
              standard: '#/components/schemas/tokenizerstandard'
              uaxUrlEmail: '#/components/schemas/tokenizeruaxUrlEmail'
              whitespace: '#/components/schemas/tokenizerwhitespace'
            propertyName: type
          oneOf:
          - $ref: '#/components/schemas/tokenizeredgeGram'
          - $ref: '#/components/schemas/tokenizerkeyword'
          - $ref: '#/components/schemas/tokenizernGram'
          - $ref: '#/components/schemas/tokenizerregexCaptureGroup'
          - $ref: '#/components/schemas/tokenizerregexSplit'
          - $ref: '#/components/schemas/tokenizerstandard'
          - $ref: '#/components/schemas/tokenizeruaxUrlEmail'
          - $ref: '#/components/schemas/tokenizerwhitespace'
      required:
      - name
      - tokenizer
      title: analyzers
    ApiAtlasFTSMappingsViewManual:
      type: object
      description: Index specifications for the collection's fields.
      properties:
        dynamic:
          type: boolean
          default: false
          description: Flag that indicates whether the index uses dynamic or static
            mappings. Required if **mappings.fields** is omitted.
          externalDocs:
            description: Dynamic or Static Mappings
            url: https://www.mongodb.com/docs/atlas/atlas-search/index-definitions/#field-mapping-examples
        fields:
          type: object
          additionalProperties:
            type: object
            externalDocs:
              description: Atlas Search Field Mappings
              url: https://www.mongodb.com/docs/atlas/atlas-search/define-field-mappings/#define-field-mappings
          description: One or more field specifications for the Atlas Search index.
            Required if **mappings.dynamic** is omitted or set to **false**.
          externalDocs:
            description: Atlas Search Index
            url: https://www.mongodb.com/docs/atlas/atlas-search/index-definitions/
      title: mappings
    ApiAtlasSnapshotScheduleView:
      type: object
      properties:
        clusterCheckpointIntervalMin:
          type: integer
          format: int32
          description: Quantity of time expressed in minutes between successive cluster
            checkpoints. This parameter applies only to sharded clusters. This number
            determines the granularity of continuous cloud backups for sharded clusters.
          enum:
          - 15
          - 30
          - 60
        clusterId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshot you want to return.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        dailySnapshotRetentionDays:
          type: integer
          format: int32
          description: Quantity of time to keep daily snapshots. MongoDB Cloud expresses
            this value in days. Set this value to `0` to disable daily snapshot retention.
          enum:
          - 0
          - 3
          - 4
          - 5
          - 6
          - 7
          - 15
          - 30
          - 60
          - 90
          - 120
          - 180
          - 360
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the cluster.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        monthlySnapshotRetentionMonths:
          type: integer
          format: int32
          description: Number of months that MongoDB Cloud must keep monthly snapshots.
            Set this value to `0` to disable monthly snapshot retention.
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          - 11
          - 12
          - 13
          - 18
          - 24
          - 36
        pointInTimeWindowHours:
          type: integer
          format: int32
          description: Number of hours before the current time from which MongoDB
            Cloud can create a Continuous Cloud Backup snapshot.
        snapshotIntervalHours:
          type: integer
          format: int32
          description: Number of hours that must elapse before taking another snapshot.
          enum:
          - 6
          - 8
          - 12
          - 24
        snapshotRetentionDays:
          type: integer
          format: int32
          description: Number of days that MongoDB Cloud must keep recent snapshots.
          enum:
          - 2
          - 3
          - 4
          - 5
        weeklySnapshotRetentionWeeks:
          type: integer
          format: int32
          description: Number of weeks that MongoDB Cloud must keep weekly snapshots.
            Set this value to `0` to disable weekly snapshot retention.
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 12
          - 16
          - 20
          - 24
          - 52
      required:
      - clusterCheckpointIntervalMin
      - clusterId
      - dailySnapshotRetentionDays
      - groupId
      - monthlySnapshotRetentionMonths
      - pointInTimeWindowHours
      - snapshotIntervalHours
      - snapshotRetentionDays
      - weeklySnapshotRetentionWeeks
    ApiBSONTimestampView:
      type: object
      description: BSON timestamp that indicates when the checkpoint token entry in
        the oplog occurred.
      properties:
        date:
          type: string
          format: date-time
          description: Date and time when the oplog recorded this database operation.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          readOnly: true
        increment:
          type: integer
          format: int32
          description: Order of the database operation that the oplog recorded at
            specific date and time.
          example: 1199145600
          minimum: 1199145600
          readOnly: true
      readOnly: true
      title: BSON Timestamp
    ApiCheckpointPartView:
      type: object
      description: Metadata contained in one document that describes the complete
        snapshot taken for this node.
      properties:
        replicaSetName:
          type: string
          description: Human-readable label that identifies the replica set to which
            this checkpoint applies.
          readOnly: true
        shardName:
          type: string
          description: Human-readable label that identifies the shard to which this
            checkpoint applies.
          readOnly: true
        tokenDiscovered:
          type: boolean
          description: Flag that indicates whether the token exists.
          readOnly: true
        tokenTimestamp:
          $ref: '#/components/schemas/ApiBSONTimestampView'
        typeName:
          type: string
          description: Human-readable label that identifies the type of host that
            the part represents.
          enum:
          - REPLICA_SET
          - CONFIG_SERVER
          - CONFIG_SERVER_REPLICA_SET
          readOnly: true
      readOnly: true
    ApiError:
      type: object
      properties:
        detail:
          type: string
          description: Describes the specific conditions or reasons that cause each
            type of error.
        error:
          type: integer
          format: int32
          description: HTTP status code returned with this error.
          externalDocs:
            url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
        errorCode:
          type: string
          description: Application error code returned with this error.
        parameters:
          type: array
          description: Parameters used to give more information about the error.
          items:
            type: object
        reason:
          type: string
          description: Application error message returned with this error.
    ApiHostView_Atlas:
      type: object
      properties:
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created this MongoDB process.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project.
            The project contains MongoDB processes that you want to return. The MongoDB
            process can be either the `mongod` or `mongos`.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        hostname:
          type: string
          description: "Hostname, fully qualified domain name (FQDN), or Internet\
            \ Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process\
            \ (`mongod` or `mongos`)."
          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]+)?$"
          readOnly: true
        id:
          type: string
          description: "Combination of hostname and Internet Assigned Numbers Authority\
            \ (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."
          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})$"
          readOnly: true
        lastPing:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud received the last ping for
            this MongoDB process. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          readOnly: true
        links:
          type: array
          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_Atlas'
          readOnly: true
        port:
          type: integer
          format: int32
          description: Internet Assigned Numbers Authority (IANA) port on which the
            MongoDB process listens for requests.
          readOnly: true
        replicaSetName:
          type: string
          description: Human-readable label that identifies the replica set that contains
            this process. This resource returns this parameter if this process belongs
            to a replica set.
          readOnly: true
        shardName:
          type: string
          description: Human-readable label that identifies the shard that contains
            this process. This resource returns this value only if this process belongs
            to a sharded cluster.
          readOnly: true
        typeName:
          type: string
          description: Type of MongoDB process that MongoDB Cloud tracks. MongoDB
            Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes
            deploying the process.
          enum:
          - REPLICA_PRIMARY
          - REPLICA_SECONDARY
          - RECOVERING
          - SHARD_MONGOS
          - SHARD_CONFIG
          - SHARD_STANDALONE
          - SHARD_PRIMARY
          - SHARD_SECONDARY
          - NO_DATA
          readOnly: true
        userAlias:
          type: string
          description: Human-readable label that identifies the cluster node. MongoDB
            Cloud sets this hostname usually to the standard hostname for the cluster
            node. It appears in the connection string for a cluster instead of the
            value of the hostname parameter.
          readOnly: true
        version:
          type: string
          description: Version of MongoDB that this process runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
    ApiKey:
      type: object
      description: Details contained in one API key.
      nullable: true
      properties:
        accessList:
          type: array
          description: List of network addresses granted access to this API using
            this API key.
          items:
            $ref: '#/components/schemas/AccessListItemView'
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this organization
            API key.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          description: Public API key value set for the specified organization API
            key.
          maxLength: 8
          minLength: 8
          readOnly: true
        roles:
          type: array
          description: List that contains roles that the API key needs to have. All
            roles you provide must be valid for the specified project or organization.
            Each request must include a minimum of one valid role. The resource returns
            all project and organization roles assigned to the Cloud user.
          items:
            $ref: '#/components/schemas/CloudAccessRoleAssignment'
          readOnly: true
      readOnly: true
      required:
      - id
      - publicKey
    ApiKeyUserDetails:
      type: object
      description: Details of the Programmatic API Keys.
      properties:
        desc:
          type: string
          description: Purpose or explanation provided when someone created this organization
            API key.
          maxLength: 250
          minLength: 1
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this organization
            API key assigned to this project.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        privateKey:
          type: string
          description: Redacted private key returned for this organization API key.
            This key displays unredacted when first created.
          example: 55c3bbb6-b4bb-0be1-e66d20841f3e
          readOnly: true
        publicKey:
          type: string
          description: Public API key value set for the specified organization API
            key.
          example: zmmrboas
          maxLength: 8
          minLength: 8
          readOnly: true
        roles:
          type: array
          description: List that contains the roles that the API key needs to have.
            All roles you provide must be valid for the specified project or organization.
            Each request must include a minimum of one valid role. The resource returns
            all project and organization roles assigned to the API key.
          items:
            $ref: '#/components/schemas/CloudAccessRoleAssignment'
    ApiMeasurementsGeneralView_Atlas:
      type: object
      properties:
        databaseName:
          type: string
          description: Human-readable label that identifies the database that the
            specified MongoDB process serves.
          readOnly: true
        end:
          type: string
          format: date-time
          description: "Date and time that specifies when to stop retrieving measurements.\
            \ If you set **end**, you must set **start**. You can't set this parameter\
            \ and **period** in the same request. This parameter expresses its value\
            \ in the ISO 8601 timestamp format in UTC."
          readOnly: true
        granularity:
          type: string
          description: "Duration that specifies the interval between measurement data\
            \ points. The parameter expresses its value in ISO 8601 timestamp format\
            \ in UTC. If you set this parameter, you must set either **period** or\
            \ **start** and **end**."
          enum:
          - PT1M
          - PT5M
          - PT1H
          - P1D
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project.
            The project contains MongoDB processes that you want to return. The MongoDB
            process can be either the `mongod` or `mongos`.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        hostId:
          type: string
          description: "Combination of hostname and Internet Assigned Numbers Authority\
            \ (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."
          example: mongodb.example.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})$"
          readOnly: true
        links:
          type: array
          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_Atlas'
          readOnly: true
        measurements:
          type: array
          description: List that contains measurements and their data points.
          items:
            $ref: '#/components/schemas/MetricsMeasurement_Atlas'
          readOnly: true
        partitionName:
          type: string
          description: Human-readable label of the disk or partition to which the
            measurements apply.
          readOnly: true
        processId:
          type: string
          description: "Combination of hostname and Internet Assigned Numbers Authority\
            \ (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."
          example: mongodb.example.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})$"
          readOnly: true
        start:
          type: string
          format: date-time
          description: "Date and time that specifies when to start retrieving measurements.\
            \ If you set **start**, you must set **end**. You can't set this parameter\
            \ and **period** in the same request. This parameter expresses its value\
            \ in the ISO 8601 timestamp format in UTC."
          readOnly: true
    ApiSearchDeploymentRequestView:
      type: object
      properties:
        specs:
          type: array
          description: List of settings that configure the Search Nodes for your cluster.
          items:
            $ref: '#/components/schemas/ApiSearchDeploymentSpecView'
          maxItems: 1
          minItems: 1
      required:
      - specs
    ApiSearchDeploymentResponseView:
      type: object
      properties:
        groupId:
          type: string
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the search
            deployment.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        specs:
          type: array
          description: List of settings that configure the Search Nodes for your cluster.
          items:
            $ref: '#/components/schemas/ApiSearchDeploymentSpecView'
          readOnly: true
        stateName:
          type: string
          description: Human-readable label that indicates the current operating condition
            of this search deployment.
          enum:
          - IDLE
          - PAUSED
          - UPDATING
          readOnly: true
    ApiSearchDeploymentSpecView:
      type: object
      properties:
        instanceSize:
          type: string
          description: Hardware specification for the Search Node instance sizes.
          enum:
          - S20_HIGHCPU_NVME
          - S30_HIGHCPU_NVME
          - S40_HIGHCPU_NVME
          - S50_HIGHCPU_NVME
          - S60_HIGHCPU_NVME
          - S70_HIGHCPU_NVME
          - S80_HIGHCPU_NVME
          - S30_LOWCPU_NVME
          - S40_LOWCPU_NVME
          - S50_LOWCPU_NVME
          - S60_LOWCPU_NVME
          - S70_LOWCPU_NVME
          - S80_LOWCPU_NVME
          - S90_LOWCPU_NVME
          - S100_LOWCPU_NVME
          - S110_LOWCPU_NVME
          - S120_LOWCPU_NVME
          - S130_LOWCPU_NVME
          - S135_LOWCPU_NVME
          - S140_LOWCPU_NVME
        nodeCount:
          type: integer
          format: int32
          description: Number of Search Nodes in the cluster.
          example: 2
          maximum: 32
          minimum: 2
      required:
      - instanceSize
      - nodeCount
    ApiStreamsAWSRegionView:
      type: string
      description: Atlas Streams AWS Regions.
      enum:
      - SYDNEY_AUS
      - MUMBAI_IND
      - FRANKFURT_DEU
      - DUBLIN_IRL
      - LONDON_GBR
      - VIRGINIA_USA
      - OREGON_USA
      - SAOPAULO_BRA
      - SINGAPORE_SGP
    ApiStreamsAzureRegionView:
      type: string
      description: Atlas Streams Azure Regions.
      enum:
      - VIRGINIA_USA
      - CALIFORNIA_USA
      - SINGAPORE_SGP
      - DUBLIN_IRL
      - AMSTERDAM_NLD
      - SYDNEY_AUS
    ApiUserEventTypeViewForNdsGroup:
      type: string
      description: Unique identifier of event type.
      enum:
      - API_KEY_CREATED
      - API_KEY_DELETED
      - API_KEY_ACCESS_LIST_ENTRY_ADDED
      - API_KEY_ACCESS_LIST_ENTRY_DELETED
      - API_KEY_ROLES_CHANGED
      - API_KEY_DESCRIPTION_CHANGED
      - API_KEY_ADDED_TO_GROUP
      - API_KEY_REMOVED_FROM_GROUP
      - API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED
      - API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED
      example: API_KEY_CREATED
      title: API User Event Types
    ApiUserEventTypeViewForOrg:
      type: string
      description: Unique identifier of event type.
      enum:
      - API_KEY_CREATED
      - API_KEY_DELETED
      - API_KEY_ACCESS_LIST_ENTRY_ADDED
      - API_KEY_ACCESS_LIST_ENTRY_DELETED
      - API_KEY_ROLES_CHANGED
      - API_KEY_DESCRIPTION_CHANGED
      - API_KEY_ADDED_TO_GROUP
      - API_KEY_REMOVED_FROM_GROUP
      - API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED
      - API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED
      example: API_KEY_CREATED
      title: API User Event Types
    ApiUserEventViewForNdsGroup:
      type: object
      description: API User event identifies different activities around user api
        keys.
      properties:
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/ApiUserEventTypeViewForNdsGroup'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          example: test.user@mongodb.com
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: API User Events
    ApiUserEventViewForOrg:
      type: object
      description: API User event identifies different activities around user api
        keys.
      properties:
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/ApiUserEventTypeViewForOrg'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          example: test.user@mongodb.com
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: API User Events
    AppServiceAlertConfigViewForNdsGroup:
      type: object
      description: App Services metric alert configuration allows to select which
        app service conditions and events trigger alerts and how users are notified.
      properties:
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
        enabled:
          type: boolean
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
        eventTypeName:
          $ref: '#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        matchers:
          type: array
          description: "List of rules that determine whether MongoDB Cloud checks\
            \ an object for the alert configuration. You can filter using the matchers\
            \ array if the **eventTypeName** specifies an event for a host, replica\
            \ set, or sharded cluster."
          items:
            $ref: '#/components/schemas/AppServiceMetricMatcher'
        notifications:
          type: array
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            $ref: '#/components/schemas/AlertsNotificationRootForGroup'
        updated:
          type: string
          format: date-time
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
      required:
      - eventTypeName
      - notifications
      title: App Services Alert Configuration
    AppServiceAlertView:
      type: object
      description: App Services alert notifies different activities about a BAAS application.
      properties:
        acknowledgedUntil:
          type: string
          format: date-time
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

            - To acknowledge this alert forever, set the parameter value to 100 years in the future.

            - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past.
        acknowledgementComment:
          type: string
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
        acknowledgingUsername:
          type: string
          format: email
          description: MongoDB Cloud username of the person who acknowledged the alert.
            The response returns this parameter if a MongoDB Cloud user previously
            acknowledged this alert.
          readOnly: true
        alertConfigId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/AppServiceEventTypeViewAlertable'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        lastNotified:
          type: string
          format: date-time
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        resolved:
          type: string
          format: date-time
          description: "Date and time that this alert changed to `\"status\" : \"\
            CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\"\
            \ target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp\
            \ format in UTC. The resource returns this parameter once `\"status\"\
            \ : \"CLOSED\"`."
          readOnly: true
        status:
          type: string
          description: State of this alert at the time you requested its details.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
        updated:
          type: string
          format: date-time
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
      required:
      - acknowledgedUntil
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: App Services Alerts
    AppServiceEventTypeView:
      type: string
      description: Unique identifier of event type.
      enum:
      - URL_CONFIRMATION
      - SUCCESSFUL_DEPLOY
      - DEPLOYMENT_FAILURE
      - DEPLOYMENT_MODEL_CHANGE_SUCCESS
      - DEPLOYMENT_MODEL_CHANGE_FAILURE
      - REQUEST_RATE_LIMIT
      - LOG_FORWARDER_FAILURE
      - INSIDE_REALM_METRIC_THRESHOLD
      - OUTSIDE_REALM_METRIC_THRESHOLD
      - SYNC_FAILURE
      - TRIGGER_FAILURE
      - TRIGGER_AUTO_RESUMED
      example: DEPLOYMENT_FAILURE
      title: App Services Event Types
    AppServiceEventTypeViewAlertable:
      type: string
      description: Incident that triggered this alert.
      enum:
      - URL_CONFIRMATION
      - SUCCESSFUL_DEPLOY
      - DEPLOYMENT_FAILURE
      - DEPLOYMENT_MODEL_CHANGE_SUCCESS
      - DEPLOYMENT_MODEL_CHANGE_FAILURE
      - REQUEST_RATE_LIMIT
      - LOG_FORWARDER_FAILURE
      - OUTSIDE_REALM_METRIC_THRESHOLD
      - SYNC_FAILURE
      - TRIGGER_FAILURE
      - TRIGGER_AUTO_RESUMED
      example: DEPLOYMENT_FAILURE
      readOnly: true
      title: App Services Event Types
    AppServiceEventTypeViewAlertableNoThreshold:
      type: string
      description: Event type that triggers an alert.
      enum:
      - URL_CONFIRMATION
      - SUCCESSFUL_DEPLOY
      - DEPLOYMENT_FAILURE
      - REQUEST_RATE_LIMIT
      - LOG_FORWARDER_FAILURE
      - SYNC_FAILURE
      - TRIGGER_FAILURE
      - TRIGGER_AUTO_RESUMED
      - DEPLOYMENT_MODEL_CHANGE_SUCCESS
      - DEPLOYMENT_MODEL_CHANGE_FAILURE
      example: DEPLOYMENT_FAILURE
      title: App Services Event Types
    AppServiceEventTypeViewAlertableWithThreshold:
      type: string
      description: Event type that triggers an alert.
      enum:
      - OUTSIDE_REALM_METRIC_THRESHOLD
      example: OUTSIDE_REALM_METRIC_THRESHOLD
      title: App Services Event Types
    AppServiceEventView:
      type: object
      description: App Services event identifies different activities about a BAAS
        application.
      properties:
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/AppServiceEventTypeView'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
      required:
      - created
      - eventTypeName
      - id
      title: App Services Events
    AppServiceMetricAlertConfigViewForNdsGroup:
      type: object
      description: App Services metric alert configuration allows to select which
        app service metrics trigger alerts and how users are notified.
      properties:
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
        enabled:
          type: boolean
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
        eventTypeName:
          $ref: '#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        matchers:
          type: array
          description: "List of rules that determine whether MongoDB Cloud checks\
            \ an object for the alert configuration. You can filter using the matchers\
            \ array if the **eventTypeName** specifies an event for a host, replica\
            \ set, or sharded cluster."
          items:
            $ref: '#/components/schemas/AppServiceMetricMatcher'
        metricThreshold:
          $ref: '#/components/schemas/AppServiceMetricThreshold'
        notifications:
          type: array
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            $ref: '#/components/schemas/AlertsNotificationRootForGroup'
        updated:
          type: string
          format: date-time
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
      required:
      - eventTypeName
      - notifications
      title: App Services Metric Alert Configuration
    AppServiceMetricMatcher:
      type: object
      description: Rules to apply when comparing an app service metric against this
        alert configuration.
      properties:
        fieldName:
          $ref: '#/components/schemas/AppServiceMetricMatcherField'
        operator:
          type: string
          description: "Comparison operator to apply when checking the current metric\
            \ value against **matcher[n].value**."
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
        value:
          type: string
          description: Value to match or exceed using the specified **matchers.operator**.
          example: event-replica-set
      required:
      - fieldName
      - operator
      - value
      title: Matchers
    AppServiceMetricMatcherField:
      type: string
      description: Name of the parameter in the target object that MongoDB Cloud checks.
        The parameter must match all rules for MongoDB Cloud to check for alert configurations.
      enum:
      - APPLICATION_ID
      example: APPLICATION_ID
      title: App Services Metric Matcher Fields
    AppServiceMetricThreshold:
      type: object
      description: "Threshold for the metric that, when exceeded, triggers an alert.\
        \ The metric threshold pertains to event types which reflects changes of measurements\
        \ and metrics in the app services."
      discriminator:
        mapping:
          REALM_AUTH_LOGIN_FAIL: '#/components/schemas/RawMetricThresholdView'
          REALM_ENDPOINTS_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_ENDPOINTS_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_ENDPOINTS_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView'
          REALM_ENDPOINTS_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_GQL_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_GQL_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_GQL_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView'
          REALM_GQL_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_OVERALL_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_OVERALL_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_OVERALL_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView'
          REALM_SDKFNS_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView'
          REALM_SDK_FNS_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_SDK_FUNCTIONS_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_SDK_FUNCTIONS_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_SDK_MQL_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_SDK_MQL_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_SDK_MQL_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_SYNC_CLIENT_BOOTSTRAP_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_SYNC_CLIENT_CHANGESETS_INVALID: '#/components/schemas/DataMetricThresholdView'
          REALM_SYNC_CLIENT_UPLOADS_FAILED: '#/components/schemas/DataMetricThresholdView'
          REALM_SYNC_CLIENT_UPLOADS_INVALID: '#/components/schemas/DataMetricThresholdView'
          REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM: '#/components/schemas/TimeMetricThresholdView'
          REALM_SYNC_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_SYNC_FAILED_REQUESTS: '#/components/schemas/DataMetricThresholdView'
          REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT: '#/components/schemas/RawMetricThresholdView'
          REALM_SYNC_SESSIONS_ENDED: '#/components/schemas/DataMetricThresholdView'
          REALM_TRIGGERS_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView'
          REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM: '#/components/schemas/TimeMetricThresholdView'
          REALM_TRIGGERS_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView'
          REALM_TRIGGERS_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView'
          REALM_TRIGGERS_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView'
        propertyName: metricName
      properties:
        metricName:
          type: string
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured **metricThreshold.threshold**.
        mode:
          type: string
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
        operator:
          $ref: '#/components/schemas/Operator'
        threshold:
          type: number
          format: double
          description: "Value of metric that, when exceeded, triggers an alert."
        units:
          type: string
          description: "Element used to express the quantity. This can be an element\
            \ of time, storage capacity, and the like."
          enum:
          - bits
          - Kbits
          - Mbits
          - Gbits
          - bytes
          - KB
          - MB
          - GB
          - TB
          - PB
          - nsec
          - msec
          - sec
          - min
          - hours
          - million minutes
          - days
          - requests
          - 1000 requests
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          - ""
          - ""
          - ""
      required:
      - metricName
      title: App Services Metric Threshold
    AtlasClusterOutageSimulationOutageFilter:
      type: object
      properties:
        cloudProvider:
          type: string
          description: The cloud provider of the region that undergoes the outage
            simulation.
          enum:
          - AWS
          - GCP
          - AZURE
        regionName:
          type: string
          description: The name of the region to undergo an outage simulation.
        type:
          type: string
          description: |-
            The type of cluster outage to simulate.

            | Type       | Description |
            |------------|-------------|
            | `REGION`   | Simulates a cluster outage for a region.|
          enum:
          - REGION
    AtlasOrganization:
      type: object
      description: Details that describe the organization.
      properties:
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isDeleted:
          type: boolean
          description: Flag that indicates whether this organization has been deleted.
          readOnly: true
        links:
          type: array
          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
        name:
          type: string
          description: Human-readable label that identifies the organization.
          maxLength: 64
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
      required:
      - name
    AuditLog:
      type: object
      properties:
        auditAuthorizationSuccess:
          type: boolean
          default: false
          description: "Flag that indicates whether someone set auditing to track\
            \ successful authentications. This only applies to the `\"atype\" : \"\
            authCheck\"` audit filter. Setting this parameter to `true` degrades cluster\
            \ performance."
          externalDocs:
            description: System Auditing Messages
            url: https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results
        auditFilter:
          type: string
          description: "JSON document that specifies which events to record. Escape\
            \ any characters that may prevent parsing, such as single or double quotes,\
            \ using a backslash (`\\`)."
          externalDocs:
            description: Custom Auditing Filter
            url: https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/
        configurationType:
          type: string
          description: Human-readable label that displays how to configure the audit
            filter.
          enum:
          - NONE
          - FILTER_BUILDER
          - FILTER_JSON
          readOnly: true
        enabled:
          type: boolean
          default: false
          description: Flag that indicates whether someone enabled database auditing
            for the specified project.
    AuthFederationRoleMapping:
      type: object
      description: Mapping settings that link one IdP and MongoDB Cloud.
      properties:
        externalGroupName:
          type: string
          description: Unique human-readable label that identifies the identity provider
            group to which this role mapping applies.
          maxLength: 200
          minLength: 1
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this role
            mapping.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        roleAssignments:
          type: array
          description: Atlas roles and the unique identifiers of the groups and organizations
            associated with each role.
          items:
            $ref: '#/components/schemas/RoleAssignment'
          uniqueItems: true
      required:
      - externalGroupName
      title: Federated Authentication Role Mapping
    AutoExportPolicyView:
      type: object
      description: Policy for automatically exporting cloud backup snapshots.
      properties:
        exportBucketId:
          type: string
          description: Unique 24-hexadecimal character string that identifies the
            AWS Bucket.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        frequencyType:
          type: string
          description: Human-readable label that indicates the rate at which the export
            policy item occurs.
          enum:
          - monthly
          - yearly
      title: export
    AutomationConfigEventTypeView:
      type: string
      description: Unique identifier of event type.
      enum:
      - AUTOMATION_CONFIG_PUBLISHED_AUDIT
      example: AUTOMATION_CONFIG_PUBLISHED_AUDIT
      title: Automation Config Event Types
    AutomationConfigEventView:
      type: object
      description: Automation config event identifies that deployment configuration
        is published.
      properties:
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/AutomationConfigEventTypeView'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          example: test.user@mongodb.com
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: Automation Config Events
    AvailableCloudProviderRegion:
      type: object
      properties:
        default:
          type: boolean
          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
        name:
          type: string
          description: Human-readable label that identifies the supported region.
          readOnly: true
    AvailableClustersDeployment:
      type: object
      description: Deployments that can be migrated to MongoDB Atlas.
      properties:
        agentVersion:
          type: string
          description: Version of MongoDB Agent that monitors/manages the cluster.
          readOnly: true
        clusterId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the cluster.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        dbSizeBytes:
          type: integer
          format: int64
          description: Size of this database on disk at the time of the request expressed
            in bytes.
          example: 8192
          readOnly: true
        featureCompatibilityVersion:
          type: string
          description: "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion)\
            \ that this cluster supports."
          readOnly: true
        managed:
          type: boolean
          description: Flag that indicates whether Automation manages this cluster.
          readOnly: true
        mongoDBVersion:
          type: string
          description: Version of MongoDB that this cluster runs.
          readOnly: true
        name:
          type: string
          description: Human-readable label that identifies this cluster.
          example: Project X sharded cluster
          readOnly: true
        oplogSizeMB:
          type: integer
          format: int32
          description: Size of the Oplog on disk at the time of the request expressed
            in MB.
          example: 3
          readOnly: true
        sharded:
          type: boolean
          description: |-
            Flag that indicates whether someone configured this cluster as a sharded cluster.

            - If `true`, this cluster serves as a sharded cluster.
            - If `false`, this cluster serves as a replica set.
          readOnly: true
        shardsSize:
          type: integer
          format: int32
          description: Number of shards that comprise this cluster.
          example: 3
          readOnly: true
        tlsEnabled:
          type: boolean
          description: Flag that indicates whether someone enabled TLS for this cluster.
          readOnly: true
      required:
      - featureCompatibilityVersion
      - managed
      - mongoDBVersion
      - name
      - sharded
      - tlsEnabled
      title: Available Clusters
    AwsNetworkPeeringConnectionSettings:
      type: object
      description: Group of Network Peering connection settings.
      properties:
        accepterRegionName:
          type: string
          description: Amazon Web Services (AWS) region where the Virtual Peering
            Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The
            resource returns `null` if your VPC and the MongoDB Cloud VPC reside in
            the same region.
        awsAccountId:
          type: string
          description: Unique twelve-digit string that identifies the Amazon Web Services
            (AWS) account that owns the VPC that you peered with the MongoDB Cloud
            VPC.
          maxLength: 12
          minLength: 12
          pattern: "^[0-9]{12}$"
        connectionId:
          type: string
          description: Unique string that identifies the peering connection on AWS.
          readOnly: true
        containerId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        errorStateName:
          type: string
          description: Type of error that can be returned when requesting an Amazon
            Web Services (AWS) peering connection. The resource returns `null` if
            the request succeeded.
          enum:
          - REJECTED
          - EXPIRED
          - INVALID_ARGUMENT
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        providerName:
          type: string
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
        routeTableCidrBlock:
          type: string
          description: Internet Protocol (IP) addresses expressed in Classless Inter-Domain
            Routing (CIDR) notation of the VPC's subnet that you want to peer with
            the MongoDB Cloud VPC.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
        statusName:
          type: string
          description: State of the network peering connection at the time you made
            the request.
          enum:
          - INITIATING
          - PENDING_ACCEPTANCE
          - FAILED
          - FINALIZING
          - AVAILABLE
          - TERMINATING
          readOnly: true
        vpcId:
          type: string
          description: Unique string that identifies the VPC on Amazon Web Services
            (AWS) that you want to peer with the MongoDB Cloud VPC.
          minLength: 5
          pattern: "^vpc-[0-9a-f]{17}$"
      required:
      - accepterRegionName
      - awsAccountId
      - containerId
      - routeTableCidrBlock
      - vpcId
      title: AWS
    AzureCloudProviderContainer:
      type: object
      allOf:
      - $ref: '#/components/schemas/CloudProviderContainer'
      - type: object
        properties:
          atlasCidrBlock:
            type: string
            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})+$"
          azureSubscriptionId:
            type: string
            description: Unique string that identifies the Azure subscription in which
              the MongoDB Cloud VNet resides.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
          region:
            type: string
            description: Azure region to which MongoDB Cloud deployed this network
              peering container.
            enum:
            - US_CENTRAL
            - US_EAST
            - US_EAST_2
            - US_EAST_2_EUAP
            - 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_EAST
            - AUSTRALIA_SOUTH_EAST
            - AUSTRALIA_CENTRAL
            - AUSTRALIA_CENTRAL_2
            - UAE_NORTH
            - GERMANY_CENTRAL
            - GERMANY_NORTH_EAST
            - GERMANY_WEST_CENTRAL
            - GERMANY_NORTH
            - SWITZERLAND_NORTH
            - SWITZERLAND_WEST
            - SWEDEN_CENTRAL
            - SWEDEN_SOUTH
            - UK_SOUTH
            - UK_WEST
            - INDIA_CENTRAL
            - INDIA_WEST
            - INDIA_SOUTH
            - 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
            - NORWAY_EAST
            - NORWAY_WEST
            - UAE_CENTRAL
            - QATAR_CENTRAL
            - POLAND_CENTRAL
            - ISRAEL_CENTRAL
            - ITALY_NORTH
          vnetName:
            type: string
            description: Unique string that identifies the Azure VNet in which MongoDB
              Cloud clusters in this network peering container exist. The response
              returns **null** if no clusters exist in this network peering container.
            maxLength: 38
            minLength: 38
            pattern: "^([-\\w._()])+$"
            readOnly: true
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      required:
      - atlasCidrBlock
      - region
      title: AZURE
    AzureCloudProviderSettings:
      type: object
      allOf:
      - $ref: '#/components/schemas/ClusterProviderSettings'
      - type: object
        properties:
          autoScaling:
            $ref: '#/components/schemas/CloudProviderAzureAutoScaling'
          diskTypeName:
            type: string
            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
          instanceSizeName:
            type: string
            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
          regionName:
            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_CENTRAL
            - GERMANY_NORTH_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
            externalDocs:
              description: Azure
              url: https://docs.atlas.mongodb.com/reference/microsoft-azure/
            title: Azure Regions
    AzureComputeAutoScalingRules:
      type: object
      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:
          type: string
          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
        minInstanceSize:
          type: string
          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
      title: Azure
    AzureCreateDataProcessRegionView:
      type: object
      allOf:
      - $ref: '#/components/schemas/CreateDataProcessRegionView'
      - type: object
        properties:
          region:
            type: string
            description: Human-readable label that identifies the geographic location
              of the region where you wish to store your archived data.
            enum:
            - US_EAST_2
            - EUROPE_WEST
    AzureDataProcessRegionView:
      type: object
      allOf:
      - $ref: '#/components/schemas/DataProcessRegionView'
      - type: object
        properties:
          region:
            type: string
            description: Human-readable label that identifies the geographic location
              of the region where you store your archived data.
            enum:
            - US_EAST_2
            - EUROPE_WEST
            readOnly: true
    AzureHardwareSpec:
      type: object
      properties:
        instanceSize:
          type: string
          description: Hardware specification for the instance sizes in this region.
            Each instance size has a default storage and memory capacity. The instance
            size you select applies to all the data-bearing hosts in your instance
            size.
          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
        nodeCount:
          type: integer
          format: int32
          description: Number of nodes of the given type for MongoDB Cloud to deploy
            to the region.
    AzureKeyVault:
      type: object
      description: Details that define the configuration of Encryption at Rest using
        Azure Key Vault (AKV).
      externalDocs:
        description: Azure Key Vault
        url: https://www.mongodb.com/docs/atlas/security-azure-kms/
      properties:
        azureEnvironment:
          type: string
          description: Azure environment in which your account credentials reside.
          enum:
          - AZURE
          - AZURE_CHINA
          - AZURE_GERMANY
        clientID:
          type: string
          format: uuid
          description: Unique 36-hexadecimal character string that identifies an Azure
            application associated with your Azure Active Directory tenant.
        enabled:
          type: boolean
          description: "Flag that indicates whether someone enabled encryption at\
            \ rest for the specified  project. To disable encryption at rest using\
            \ customer key management and remove the configuration details, pass only\
            \ this parameter with a value of `false`."
        keyIdentifier:
          type: string
          description: Web address with a unique key that identifies for your Azure
            Key Vault.
          example: https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86
        keyVaultName:
          type: string
          description: Unique string that identifies the Azure Key Vault that contains
            your key.
        resourceGroupName:
          type: string
          description: Name of the Azure resource group that contains your Azure Key
            Vault.
        secret:
          type: string
          description: "Private data that you need secured and that belongs to the\
            \ specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**).\
            \ This data can include any type of sensitive data such as passwords,\
            \ database connection strings, API keys, and the like. AKV stores this\
            \ information as encrypted binary data."
          externalDocs:
            description: Azure Key Vault Secrets
            url: https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets
          writeOnly: true
        subscriptionID:
          type: string
          format: uuid
          description: Unique 36-hexadecimal character string that identifies your
            Azure subscription.
        tenantID:
          type: string
          format: uuid
          description: Unique 36-hexadecimal character string that identifies the
            Azure Active Directory tenant within your Azure subscription.
        valid:
          type: boolean
          description: Flag that indicates whether the Azure encryption key can encrypt
            and decrypt data.
          readOnly: true
    AzureNetworkPeeringConnectionSettings:
      type: object
      description: Group of Network Peering connection settings.
      properties:
        azureDirectoryId:
          type: string
          description: Unique string that identifies the Azure AD directory in which
            the VNet peered with the MongoDB Cloud VNet resides.
          maxLength: 32
          minLength: 32
          pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\
            b-[0-9a-fA-F]{12}$"
        azureSubscriptionId:
          type: string
          description: Unique string that identifies the Azure subscription in which
            the VNet you peered with the MongoDB Cloud VNet resides.
          maxLength: 32
          minLength: 32
          pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\
            b-[0-9a-fA-F]{12}$"
        containerId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        errorState:
          type: string
          description: "Error message returned when a requested Azure network peering\
            \ resource returns `\"status\" : \"FAILED\"`. The resource returns `null`\
            \ if the request succeeded."
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        providerName:
          type: string
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
        resourceGroupName:
          type: string
          description: Human-readable label that identifies the resource group in
            which the VNet to peer with the MongoDB Cloud VNet resides.
          pattern: "^([-\\w._()])+$"
        status:
          type: string
          description: State of the network peering connection at the time you made
            the request.
          enum:
          - ADDING_PEER
          - AVAILABLE
          - FAILED
          - DELETION_FAILED
          - DELETING
          readOnly: true
        vnetName:
          type: string
          description: Human-readable label that identifies the VNet that you want
            to peer with the MongoDB Cloud VNet.
          pattern: "^([-\\w._()])+$"
      required:
      - azureDirectoryId
      - azureSubscriptionId
      - containerId
      - resourceGroupName
      - vnetName
      title: AZURE
    AzurePrivateEndpoint:
      type: object
      description: Group of Private Endpoint settings.
      properties:
        cloudProvider:
          type: string
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
        deleteRequested:
          type: boolean
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
        errorMessage:
          type: string
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
        privateEndpointConnectionName:
          type: string
          description: Human-readable label that MongoDB Cloud generates that identifies
            the private endpoint connection.
          pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\\
            w._()]+)%2[fF]([-\\w._()]+)"
          readOnly: true
        privateEndpointIPAddress:
          type: string
          description: IPv4 address of the private endpoint in your Azure VNet that
            someone added to this private endpoint service.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
        privateEndpointResourceId:
          type: string
          description: Unique string that identifies the Azure private endpoint's
            network interface that someone added to this private endpoint service.
          example: /subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln
          readOnly: true
        status:
          type: string
          description: State of the Azure Private Link Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
      required:
      - cloudProvider
      title: AZURE
    AzurePrivateLinkConnection:
      type: object
      description: Group of Private Endpoint Service settings.
      properties:
        cloudProvider:
          type: string
          description: Cloud service provider that serves the requested endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
        errorMessage:
          type: string
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        privateEndpoints:
          type: array
          description: List of private endpoints assigned to this Azure Private Link
            Service.
          items:
            type: string
            description: Root-relative path to one private endpoint assigned to this
              Azure Private Link Service.
            pattern: "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\\
              /resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\\
              /privateEndpoints\\/([-\\w._()]+)"
            readOnly: true
          readOnly: true
        privateLinkServiceName:
          type: string
          description: Unique string that identifies the Azure Private Link Service
            that MongoDB Cloud manages.
          maxLength: 24
          minLength: 24
          pattern: "^pls_[0-9a-f]{24}$"
          readOnly: true
        privateLinkServiceResourceId:
          type: string
          description: Root-relative path that identifies of the Azure Private Link
            Service that MongoDB Cloud manages. Use this value to create a private
            endpoint connection to an Azure VNet.
          example: /subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de
          readOnly: true
        regionName:
          type: string
          description: Cloud provider region that manages this Private Endpoint Service.
          readOnly: true
        status:
          type: string
          description: State of the Private Endpoint Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - WAITING_FOR_USER
          - FAILED
          - DELETING
          readOnly: true
      required:
      - cloudProvider
      title: AZURE
    AzureRegionConfig:
      type: object
      allOf:
      - $ref: '#/components/schemas/CloudRegionConfig'
      - type: object
        properties:
          analyticsAutoScaling:
            $ref: '#/components/schemas/AdvancedAutoScalingSettings'
          analyticsSpecs:
            $ref: '#/components/schemas/DedicatedHardwareSpec'
          autoScaling:
            $ref: '#/components/schemas/AdvancedAutoScalingSettings'
          readOnlySpecs:
            $ref: '#/components/schemas/DedicatedHardwareSpec'
      description: Details that explain how MongoDB Cloud replicates data in one region
        on the specified MongoDB database.
      title: Azure Regional Replication Specifications
    BackupComplianceOnDemandPolicyItem:
      type: object
      description: Specifications for on-demand policy.
      properties:
        frequencyInterval:
          type: integer
          format: int32
          description: Number that indicates the frequency interval for a set of snapshots.
            MongoDB Cloud ignores this setting for non-hourly policy items in Backup
            Compliance Policy settings.
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          - 11
          - 12
          - 13
          - 14
          - 15
          - 16
          - 17
          - 18
          - 19
          - 20
          - 21
          - 22
          - 23
          - 24
          - 25
          - 26
          - 27
          - 28
          - 40
        frequencyType:
          type: string
          description: Human-readable label that identifies the frequency type associated
            with the backup policy.
          enum:
          - ondemand
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy item.
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        retentionUnit:
          type: string
          description: Unit of time in which MongoDB Cloud measures snapshot retention.
          enum:
          - days
          - weeks
          - months
          - years
        retentionValue:
          type: integer
          format: int32
          description: |-
            Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.

            For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.
      required:
      - frequencyInterval
      - frequencyType
      - retentionUnit
      - retentionValue
    BackupComplianceScheduledPolicyItem:
      type: object
      description: Specifications for scheduled policy.
      properties:
        frequencyInterval:
          type: integer
          format: int32
          description: |-
            Number that indicates the frequency interval for a set of snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.

            - In a yearly policy item, `1` indicates that the yearly snapshot occurs on the first day of January and `12` indicates the first day of December.

            - In a monthly policy item, `1` indicates that the monthly snapshot occurs on the first day of the month and `40` indicates the last day of the month.

            - In a weekly policy item, `1` indicates that the weekly snapshot occurs on Monday and `7` indicates Sunday.

            - In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.

             MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          - 11
          - 12
          - 13
          - 14
          - 15
          - 16
          - 17
          - 18
          - 19
          - 20
          - 21
          - 22
          - 23
          - 24
          - 25
          - 26
          - 27
          - 28
          - 40
        frequencyType:
          type: string
          description: Human-readable label that identifies the frequency type associated
            with the backup policy.
          enum:
          - daily
          - hourly
          - weekly
          - monthly
          - yearly
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy item.
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        retentionUnit:
          type: string
          description: Unit of time in which MongoDB Cloud measures snapshot retention.
          enum:
          - days
          - weeks
          - months
          - years
        retentionValue:
          type: integer
          format: int32
          description: |-
            Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.

            For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.
      required:
      - frequencyInterval
      - frequencyType
      - retentionUnit
      - retentionValue
    BackupLabel:
      type: object
      description: Collection of key-value pairs that represent custom data to add
        to the metadata file that MongoDB Cloud uploads to the bucket when the export
        job finishes.
      properties:
        key:
          type: string
          description: Key for the metadata file that MongoDB Cloud uploads to the
            bucket when the export job finishes.
        value:
          type: string
          description: Value for the key to include in file that MongoDB Cloud uploads
            to the bucket when the export job finishes.
    BackupOnlineArchive:
      type: object
      properties:
        _id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the online
            archive.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        clusterName:
          type: string
          description: Human-readable label that identifies the cluster that contains
            the collection for which you want to create an online archive.
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
        collName:
          type: string
          description: Human-readable label that identifies the collection for which
            you created the online archive.
          readOnly: true
        collectionType:
          type: string
          default: STANDARD
          description: |-
            Classification of MongoDB database collection that you want to return.

            If you set this parameter to `TIMESERIES`, set `"criteria.type" : "date"` and `"criteria.dateFormat" : "ISODATE"`.
          enum:
          - TIMESERIES
          - STANDARD
          readOnly: true
        criteria:
          $ref: '#/components/schemas/CriteriaView'
        dataExpirationRule:
          $ref: '#/components/schemas/DataExpirationRuleView'
        dataProcessRegion:
          $ref: '#/components/schemas/DataProcessRegionView'
        dataSetName:
          type: string
          description: Human-readable label that identifies the dataset that Atlas
            generates for this online archive.
          readOnly: true
        dbName:
          type: string
          description: Human-readable label of the database that contains the collection
            that contains the online archive.
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the specified cluster. The specified cluster contains the
            collection for which to create the online archive.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        partitionFields:
          type: array
          description: "List that contains document parameters to use to logically\
            \ divide data within a collection. Partitions provide a coarse level of\
            \ filtering of the underlying collection data. To divide your data, specify\
            \ parameters that you frequently query. If you \"specified :criteria.type\"\
            : \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify\
            \ up to three parameters by which to query. One of these parameters must\
            \ be the DATE value, which is required in this case. If you \"specified\
            \ :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint,\
            \ then you can specify up to two parameters by which to query. Queries\
            \ that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"\
            CUSTOM\" parameters cause MongoDB to scan a full collection of all archived\
            \ documents. This takes more time and increases your costs."
          items:
            $ref: '#/components/schemas/PartitionFieldView'
          minItems: 1
          readOnly: true
        paused:
          type: boolean
          description: "Flag that indicates whether this online archive exists in\
            \ the paused state. A request to resume fails if the collection has another\
            \ active online archive. To pause an active online archive or resume a\
            \ paused online archive, you must include this parameter. To pause an\
            \ active archive, set this to **true**. To resume a paused archive, set\
            \ this to **false**."
        schedule:
          $ref: '#/components/schemas/OnlineArchiveSchedule'
        state:
          type: string
          description: |-
            Phase of the process to create this online archive when you made this request.

            | State       | Indication |
            |-------------|------------|
            | `PENDING`   | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |
            | `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |
            | `IDLE`      | MongoDB Cloud waits to start the next archival job. |
            | `PAUSING`   | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |
            | `PAUSED`    | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |
            | `ORPHANED`  | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |
            | `DELETED`   | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |
          enum:
          - PENDING
          - ACTIVE
          - PAUSING
          - PAUSED
          - DELETED
          - ORPHANED
          readOnly: true
    BackupOnlineArchiveCreate:
      type: object
      properties:
        _id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the online
            archive.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        clusterName:
          type: string
          description: Human-readable label that identifies the cluster that contains
            the collection for which you want to create an online archive.
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
        collName:
          type: string
          description: Human-readable label that identifies the collection for which
            you created the online archive.
          writeOnly: true
        collectionType:
          type: string
          default: STANDARD
          description: |-
            Classification of MongoDB database collection that you want to return.

            If you set this parameter to `TIMESERIES`, set `"criteria.type" : "date"` and `"criteria.dateFormat" : "ISODATE"`.
          enum:
          - TIMESERIES
          - STANDARD
          writeOnly: true
        criteria:
          $ref: '#/components/schemas/CriteriaView'
        dataExpirationRule:
          $ref: '#/components/schemas/DataExpirationRuleView'
        dataProcessRegion:
          $ref: '#/components/schemas/CreateDataProcessRegionView'
        dataSetName:
          type: string
          description: Human-readable label that identifies the dataset that Atlas
            generates for this online archive.
          readOnly: true
        dbName:
          type: string
          description: Human-readable label of the database that contains the collection
            that contains the online archive.
          writeOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the specified cluster. The specified cluster contains the
            collection for which to create the online archive.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        partitionFields:
          type: array
          description: "List that contains document parameters to use to logically\
            \ divide data within a collection. Partitions provide a coarse level of\
            \ filtering of the underlying collection data. To divide your data, specify\
            \ parameters that you frequently query. If you \"specified :criteria.type\"\
            : \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify\
            \ up to three parameters by which to query. One of these parameters must\
            \ be the DATE value, which is required in this case. If you \"specified\
            \ :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint,\
            \ then you can specify up to two parameters by which to query. Queries\
            \ that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"\
            CUSTOM\" parameters cause MongoDB to scan a full collection of all archived\
            \ documents. This takes more time and increases your costs."
          items:
            $ref: '#/components/schemas/PartitionFieldView'
          minItems: 1
          writeOnly: true
        paused:
          type: boolean
          description: "Flag that indicates whether this online archive exists in\
            \ the paused state. A request to resume fails if the collection has another\
            \ active online archive. To pause an active online archive or resume a\
            \ paused online archive, you must include this parameter. To pause an\
            \ active archive, set this to **true**. To resume a paused archive, set\
            \ this to **false**."
        schedule:
          $ref: '#/components/schemas/OnlineArchiveSchedule'
        state:
          type: string
          description: |-
            Phase of the process to create this online archive when you made this request.

            | State       | Indication |
            |-------------|------------|
            | `PENDING`   | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |
            | `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |
            | `IDLE`      | MongoDB Cloud waits to start the next archival job. |
            | `PAUSING`   | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |
            | `PAUSED`    | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |
            | `ORPHANED`  | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |
            | `DELETED`   | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |
          enum:
          - PENDING
          - ACTIVE
          - PAUSING
          - PAUSED
          - DELETED
          - ORPHANED
          readOnly: true
      required:
      - collName
      - criteria
      - dbName
    BackupRestoreJob:
      type: object
      properties:
        batchId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the batch
            to which this restore job belongs. This parameter exists only for a sharded
            cluster restore.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        checkpointId:
          type: string
          description: |-
            Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`. Use this parameter with sharded clusters only.

            - If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.
            - If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          writeOnly: true
        clusterId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshot you want to return. This parameter returns for restore
            clusters.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        clusterName:
          type: string
          description: Human-readable label that identifies the cluster containing
            the snapshots you want to retrieve.
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when someone requested this restore job. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          readOnly: true
        delivery:
          $ref: '#/components/schemas/BackupRestoreJobDelivery'
        encryptionEnabled:
          type: boolean
          description: Flag that indicates whether someone encrypted the data in the
            restored snapshot.
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns the snapshots.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        hashes:
          type: array
          description: "List that contains documents mapping each restore file to\
            \ a hashed checksum. This parameter applies after you download the corresponding\
            \ **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains\
            \ one object that represents the hash of the **.tar.gz** file."
          items:
            $ref: '#/components/schemas/RestoreJobFileHash'
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the restore
            job.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        masterKeyUUID:
          type: string
          format: uuid
          description: "Universally Unique Identifier (UUID) that identifies the Key\
            \ Management Interoperability (KMIP) master key used to encrypt the snapshot\
            \ data. This parameter applies only when `\"encryptionEnabled\" : \"true\"\
            `."
          readOnly: true
        oplogInc:
          type: integer
          format: int32
          description: |-
            Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`.

            - If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.
            - If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.
          minimum: 1
          writeOnly: true
        oplogTs:
          type: string
          description: |-
            Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.

            - If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.
            - If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.
          pattern: "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\
            \\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\
            \\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\\
            d:[0-5]\\\\d)$"
          writeOnly: true
        pointInTimeUTCMillis:
          type: integer
          format: int64
          description: |-
            Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`.

            - If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.
            - If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.
          minimum: 1199145600000
          writeOnly: true
        snapshotId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the snapshot\
            \ to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**,\
            \ **pointInTimeUTCMillis**, or **checkpointId**."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        statusName:
          type: string
          description: Human-readable label that identifies the status of the downloadable
            file at the time of the request.
          enum:
          - IN_PROGRESS
          - BROKEN
          - KILLED
          - FINISHED
          readOnly: true
        timestamp:
          $ref: '#/components/schemas/ApiBSONTimestampView'
      required:
      - delivery
    BackupRestoreJobDelivery:
      type: object
      description: Method and details that indicate how to deliver the restored snapshot
        data.
      properties:
        authHeader:
          type: string
          description: "Header name to use when downloading the restore, used with\
            \ `\"delivery.methodName\" : \"HTTP\"`."
          readOnly: true
        authValue:
          type: string
          description: "Header value to use when downloading the restore, used with\
            \ `\"delivery.methodName\" : \"HTTP\"`."
          readOnly: true
        expirationHours:
          type: integer
          format: int32
          description: "Number of hours after the restore job completes that indicates\
            \ when the Uniform Resource Locator (URL) for the snapshot download file\
            \ expires. The resource returns this parameter when `\"delivery.methodName\"\
            \ : \"HTTP\"`."
          minimum: 1
        expires:
          type: string
          format: date-time
          description: "Date and time when the Uniform Resource Locator (URL) for\
            \ the snapshot download file expires. This parameter expresses its value\
            \ in the ISO 8601 timestamp format in UTC. The resource returns this parameter\
            \ when `\"delivery.methodName\" : \"HTTP\"`."
          readOnly: true
        maxDownloads:
          type: integer
          format: int32
          description: "Positive integer that indicates how many times you can use\
            \ the Uniform Resource Locator (URL) for the snapshot download file. The\
            \ resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"\
            `."
          minimum: 1
        methodName:
          type: string
          description: "Human-readable label that identifies the means for delivering\
            \ the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"\
            `, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName**\
            \ or **delivery.targetClusterId**. The response returns `\"delivery.methodName\"\
            \ : \"HTTP\"` as an automated restore uses HyperText Transport Protocol\
            \ (HTTP) to deliver the restore job to the target host."
          enum:
          - CLIENT_PIT_HTTP
          - QUERY
          - AUTOMATED_RESTORE
          - HTTP
          - THIRD_PARTY_COPY
          - CLIENT_PIT_SCP
          - SCP
        statusName:
          type: string
          description: State of the downloadable snapshot file when MongoDB Cloud
            received this request.
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - READY
          - FAILED
          - INTERRUPTED
          - EXPIRED
          - MAX_DOWNLOADS_EXCEEDED
          readOnly: true
        targetClusterId:
          type: string
          description: |-
            Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`.

             If the target cluster doesn't have backup enabled, two resources return parameters with empty values:

            - **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements
            - **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.

            To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        targetClusterName:
          type: string
          description: |-
            Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints.  This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`.

            If the target cluster doesn't have backup enabled, two resources return parameters with empty values:

            - **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements
            - **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.

            To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
        targetGroupId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the project\
            \ that contains the destination cluster for the restore job. The resource\
            \ returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"\
            `."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        url:
          type: string
          deprecated: true
          description: "Uniform Resource Locator (URL) from which you can download\
            \ the restored snapshot data. Url includes the verification key. The resource\
            \ returns this parameter when `\"delivery.methodName\" : \"HTTP\"`."
          readOnly: true
        urlV2:
          type: string
          description: "Uniform Resource Locator (URL) from which you can download\
            \ the restored snapshot data. This should be preferred over **url**. The\
            \ verification key must be sent as an HTTP header. The resource returns\
            \ this parameter when `\"delivery.methodName\" : \"HTTP\"`."
          readOnly: true
      required:
      - methodName
      title: Restore Snapshot Delivery Metadata
    BackupSnapshot:
      type: object
      properties:
        clusterId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshots you want to return.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        complete:
          type: boolean
          description: Flag that indicates whether the snapshot exists. This flag
            returns `false` while MongoDB Cloud creates the snapshot.
          readOnly: true
        created:
          $ref: '#/components/schemas/ApiBSONTimestampView'
        doNotDelete:
          type: boolean
          description: "Flag that indicates whether someone can delete this snapshot.\
            \ You can't set `\"doNotDelete\" : true` and set a timestamp for **expires**\
            \ in the same request."
        expires:
          type: string
          format: date-time
          description: "Date and time when MongoDB Cloud deletes the snapshot. If\
            \ `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this\
            \ parameter."
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns the snapshots.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        incremental:
          type: boolean
          description: Flag indicating if this is an incremental or a full snapshot.
          readOnly: true
        lastOplogAppliedTimestamp:
          $ref: '#/components/schemas/ApiBSONTimestampView'
        links:
          type: array
          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
        parts:
          type: array
          description: |-
            Metadata that describes the complete snapshot.

            - For a replica set, this array contains a single document.
            - For a sharded cluster, this array contains one document for each shard plus one document for the config host.
          items:
            $ref: '#/components/schemas/BackupSnapshotPart'
          readOnly: true
    BackupSnapshotPart:
      type: object
      description: Characteristics that identify this snapshot.
      properties:
        clusterId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshots you want to return.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        compressionSetting:
          type: string
          description: Human-readable label that identifies the method of compression
            for the snapshot.
          enum:
          - NONE
          - GZIP
          readOnly: true
        dataSizeBytes:
          type: integer
          format: int64
          description: Total size of the data stored on each node in the cluster.
            This parameter expresses its value in bytes.
          readOnly: true
        encryptionEnabled:
          type: boolean
          description: Flag that indicates whether someone encrypted this snapshot.
          readOnly: true
        fileSizeBytes:
          type: integer
          format: int64
          description: Number that indicates the total size of the data files in bytes.
          readOnly: true
        masterKeyUUID:
          type: string
          format: uuid
          description: "Unique string that identifies the Key Management Interoperability\
            \ (KMIP) master key used to encrypt the snapshot data. The resource returns\
            \ this parameter when `\"parts.encryptionEnabled\" : true`."
          readOnly: true
        mongodVersion:
          type: string
          description: Number that indicates the version of MongoDB that the replica
            set primary ran when MongoDB Cloud created the snapshot.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
        replicaSetName:
          type: string
          description: Human-readable label that identifies the replica set.
          readOnly: true
        storageSizeBytes:
          type: integer
          format: int64
          description: Number that indicates the total size of space allocated for
            document storage.
          readOnly: true
        typeName:
          type: string
          description: Human-readable label that identifies the type of server from
            which MongoDB Cloud took this snapshot.
          enum:
          - REPLICA_SET
          - CONFIG_SERVER
          - CONFIG_SERVER_REPLICA_SET
          readOnly: true
      readOnly: true
      title: Snapshot Components
    BackupSnapshotRetention:
      type: object
      properties:
        links:
          type: array
          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
        retentionUnit:
          type: string
          description: Quantity of time in which MongoDB Cloud measures snapshot retention.
          enum:
          - DAYS
          - WEEKS
          - MONTHS
          - YEARS
        retentionValue:
          type: integer
          format: int32
          description: "Number that indicates the amount of days, weeks, months, or\
            \ years that MongoDB Cloud retains the snapshot. For less frequent policy\
            \ items, MongoDB Cloud requires that you specify a value greater than\
            \ or equal to the value specified for more frequent policy items. If the\
            \ hourly policy item specifies a retention of two days, specify two days\
            \ or greater for the retention of the weekly policy item."
          example: 5
      required:
      - retentionUnit
      - retentionValue
    BackupTenantSnapshot:
      type: object
      properties:
        expiration:
          type: string
          format: date-time
          description: Date and time when the download link no longer works. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          readOnly: true
        finishTime:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud completed writing this snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the restore
            job.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        mongoDBVersion:
          type: string
          description: MongoDB host version that the snapshot runs.
          readOnly: true
        scheduledTime:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud will take the snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          readOnly: true
        startTime:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud began taking the snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          readOnly: true
        status:
          type: string
          description: Phase of the workflow for this snapshot at the time this resource
            made this request.
          enum:
          - PENDING
          - QUEUED
          - RUNNING
          - FAILED
          - COMPLETED
          readOnly: true
    BaseAtlasDataLakeRegion:
      type: object
      description: Name of the region to which the data lake routes client connections.
      oneOf:
      - $ref: '#/components/schemas/ApiAtlasDataLakeAWSRegionView'
      - $ref: '#/components/schemas/ApiAtlasDataLakeAzureRegionView'
    BaseCloudProviderInstanceSize:
      type: object
      description: "Minimum instance size to which your cluster can automatically\
        \ scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\"\
        \ : true`."
      oneOf:
      - type: string
        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
    BaseNetworkPeeringConnectionSettings:
      type: object
      discriminator:
        mapping:
          AWS: '#/components/schemas/AwsNetworkPeeringConnectionSettings'
          AZURE: '#/components/schemas/AzureNetworkPeeringConnectionSettings'
          GCP: '#/components/schemas/GCPNetworkPeeringConnectionSettings'
        propertyName: providerName
      oneOf:
      - $ref: '#/components/schemas/AwsNetworkPeeringConnectionSettings'
      - $ref: '#/components/schemas/AzureNetworkPeeringConnectionSettings'
      - $ref: '#/components/schemas/GCPNetworkPeeringConnectionSettings'
      properties:
        containerId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        providerName:
          type: string
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
      required:
      - containerId
    BaseStreamsRegion:
      type: object
      description: Name of the cloud provider region hosting Atlas Stream Processing.
      oneOf:
      - $ref: '#/components/schemas/ApiStreamsAWSRegionView'
      - $ref: '#/components/schemas/ApiStreamsAzureRegionView'
    BasicBSONList:
      type: array
      description: "List that contains the search criteria that the query uses. To\
        \ use the values in key-value pairs in these predicates requires **Project\
        \ Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud\
        \ redacts these values."
      items:
        type: object
        description: "List that contains the search criteria that the query uses.\
          \ To use the values in key-value pairs in these predicates requires **Project\
          \ Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud\
          \ redacts these values."
        readOnly: true
      readOnly: true
    BasicDBObject:
      type: object
      additionalProperties:
        type: object
        description: Fields to index for vector search.
        title: Field
      description: Fields to index for vector search.
      title: Field
    BiConnector:
      type: object
      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:
          type: boolean
          description: Flag that indicates whether MongoDB Connector for Business
            Intelligence is enabled on the specified cluster.
        readPreference:
          type: string
          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
      title: MongoDB Connector for Business Intelligence Settings
    BillingEventTypeViewAlertableWithThreshold:
      type: string
      description: Event type that triggers an alert.
      enum:
      - PENDING_INVOICE_OVER_THRESHOLD
      - DAILY_BILL_OVER_THRESHOLD
      example: PENDING_INVOICE_OVER_THRESHOLD
      title: Billing Event Type
    BillingEventTypeViewForNdsGroup:
      type: string
      description: Unique identifier of event type.
      enum:
      - CREDIT_CARD_CURRENT
      - CREDIT_CARD_ABOUT_TO_EXPIRE
      - PENDING_INVOICE_UNDER_THRESHOLD
      - PENDING_INVOICE_OVER_THRESHOLD
      - DAILY_BILL_UNDER_THRESHOLD
      - DAILY_BILL_OVER_THRESHOLD
      example: CREDIT_CARD_CURRENT
      title: Billing Event Types
    BillingEventTypeViewForOrg:
      type: string
      description: Unique identifier of event type.
      enum:
      - CHARGE_SUCCEEDED
      - CHARGE_FAILED
      - CHARGE_PROCESSING
      - CHARGE_PENDING_REVERSAL
      - BRAINTREE_CHARGE_FAILED
      - INVOICE_CLOSED
      - CHECK_PAYMENT_RECEIVED
      - WIRE_TRANSFER_PAYMENT_RECEIVED
      - DISCOUNT_APPLIED
      - CREDIT_ISSUED
      - CREDIT_PULLED_FWD
      - CREDIT_END_DATE_MODIFIED
      - PROMO_CODE_APPLIED
      - PAYMENT_FORGIVEN
      - REFUND_ISSUED
      - ACCOUNT_DOWNGRADED
      - ACCOUNT_UPGRADED
      - ACCOUNT_MODIFIED
      - SUPPORT_PLAN_ACTIVATED
      - SUPPORT_PLAN_CANCELLED
      - SUPPORT_PLAN_CANCELLATION_SCHEDULED
      - INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC
      - INVOICE_ADDRESS_CHANGED
      - INVOICE_ADDRESS_ADDED
      - PREPAID_PLAN_ACTIVATED
      - ELASTIC_INVOICING_MODE_ACTIVATED
      - ELASTIC_INVOICING_MODE_DEACTIVATED
      - TERMINATE_PAID_SERVICES
      - BILLING_EMAIL_ADDRESS_ADDED
      - BILLING_EMAIL_ADDRESS_CHANGED
      - BILLING_EMAIL_ADDRESS_REMOVED
      - AWS_BILLING_ACCOUNT_CREDIT_ISSUED
      - GCP_BILLING_ACCOUNT_CREDIT_ISSUED
      - CREDIT_SFOLI_MODIFIED
      - CREDIT_SFOLID_MODIFIED
      - PREPAID_PLAN_MODIFIED
      - AWS_USAGE_REPORTED
      - AZURE_USAGE_REPORTED
      - GCP_USAGE_REPORTED
      - BECAME_PAYING_ORG
      - NEW_LINKED_ORG
      - UNLINKED_ORG
      - ORG_LINKED_TO_PAYING_ORG
      - ORG_UNLINKED_FROM_PAYING_ORG
      - ORG_UNLINK_REQUESTED
      - ORG_UNLINK_CANCELLED
      - PAYMENT_UPDATED_THROUGH_API
      - AZURE_BILLING_ACCOUNT_CREDIT_ISSUED
      - CREDIT_START_DATE_MODIFIED
      - CREDIT_ELASTIC_INVOICING_MODIFIED
      - CREDIT_TYPE_MODIFIED
      - CREDIT_AMOUNT_CENTS_MODIFIED
      - CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED
      - CREDIT_TOTAL_BILLED_CENTS_MODIFIED
      - CREDIT_AWS_CUSTOMER_ID_MODIFIED
      - CREDIT_AWS_PRODUCT_CODE_MODIFIED
      - CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED
      - CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED
      - CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED
      - TARGETED_REBILL_EXECUTED
      - LEGACY_REBILL_EXECUTED
      - EVERGREEN_DEAL_CANCELLED
      - GRACE_PERIOD_ACTIVATED
      - GRACE_PERIOD_NO_LONGER_IN_EFFECT
      - PENDING_DEAL_ACTIVATION_ADDED
      - PENDING_DEAL_ACTIVATION_CANCELED
      - PENDING_DEAL_APPLIED
      - PENDING_DEAL_ACTIVATION_FAILED
      example: CHARGE_SUCCEEDED
      title: Billing Event Types
    BillingEventViewForNdsGroup:
      type: object
      description: "Billing event identifies different activities related to billing,\
        \ payment or financial status change of an organization."
      properties:
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/BillingEventTypeViewForNdsGroup'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        invoiceId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies of the invoice
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        paymentId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the invoice
            payment associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          example: test.user@mongodb.com
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: Billing Events
    BillingEventViewForOrg:
      type: object
      description: "Billing event identifies different activities related to billing,\
        \ payment or financial status change of an organization."
      properties:
        apiKeyId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the [API\
            \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\
            \ triggered the event. If this resource returns this parameter, it doesn't\
            \ return the **userId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when this event occurred. This parameter expresses
            its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank"
            rel="noopener noreferrer">ISO 8601</a> timestamp format in UTC.
          readOnly: true
        eventTypeName:
          $ref: '#/components/schemas/BillingEventTypeViewForOrg'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The **eventId** identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        invoiceId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies of the invoice
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        isGlobalAdmin:
          type: boolean
          default: false
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        paymentId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the invoice
            payment associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        publicKey:
          type: string
          format: email
          description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\
            \ that triggered the event. If this resource returns this parameter, it\
            \ doesn't return the **username** parameter."
          example: test.user@mongodb.com
          readOnly: true
        raw:
          $ref: '#/components/schemas/raw'
        remoteAddress:
          type: string
          description: IPv4 or IPv6 address from which the user triggered this event.
          example: 216.172.40.186
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
        userId:
          type: string
          description: "Unique 24-hexadecimal digit string that identifies the console\
            \ user who triggered the event. If this resource returns this parameter,\
            \ it doesn't return the **apiKeyId** parameter."
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        username:
          type: string
          format: email
          description: "Email address for the user who triggered this event. If this\
            \ resource returns this parameter, it doesn't return the **publicApiKey**\
            \ parameter."
          example: test.user@mongodb.com
          readOnly: true
      required:
      - created
      - eventTypeName
      - id
      title: Billing Events
    BillingInvoice:
      type: object
      properties:
        amountBilledCents:
          type: integer
          format: int64
          description: Sum of services that the specified organization consumed in
            the period covered in this invoice. This parameter expresses its value
            in cents (100ths of one US Dollar) and calculates its value as **subtotalCents**
            + **salesTaxCents** - **startingBalanceCents**.
          readOnly: true
        amountPaidCents:
          type: integer
          format: int64
          description: Sum that the specified organization paid toward this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created this invoice. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          readOnly: true
        creditsCents:
          type: integer
          format: int64
          description: Sum that MongoDB credited the specified organization toward
            this invoice. This parameter expresses its value in cents (100ths of one
            US Dollar).
          readOnly: true
        endDate:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud finished the billing period
            that this invoice covers. This parameter expresses its value in the ISO
            8601 timestamp format in UTC.
          readOnly: true
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            associated to this invoice. This identifying string doesn't appear on
            all invoices.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the invoice
            submitted to the specified organization. Charges typically post the next
            day.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        lineItems:
          type: array
          description: List that contains individual services included in this invoice.
          items:
            $ref: '#/components/schemas/InvoiceLineItem'
          readOnly: true
        linkedInvoices:
          type: array
          description: List that contains the invoices for organizations linked to
            the paying organization.
          items:
            $ref: '#/components/schemas/BillingInvoice'
          readOnly: true
        links:
          type: array
          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
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            charged for services consumed from MongoDB Cloud.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        payments:
          type: array
          description: List that contains funds transferred to MongoDB to cover the
            specified service noted in this invoice.
          items:
            $ref: '#/components/schemas/BillingPayment'
          readOnly: true
        refunds:
          type: array
          description: List that contains payments that MongoDB returned to the organization
            for this invoice.
          items:
            $ref: '#/components/schemas/BillingRefund'
          readOnly: true
        salesTaxCents:
          type: integer
          format: int64
          description: Sum of sales tax applied to this invoice. This parameter expresses
            its value in cents (100ths of one US Dollar).
          readOnly: true
        startDate:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud began the billing period that
            this invoice covers. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          readOnly: true
        startingBalanceCents:
          type: integer
          format: int64
          description: Sum that the specified organization owed to MongoDB when MongoDB
            issued this invoice. This parameter expresses its value in US Dollars.
          readOnly: true
        statusName:
          type: string
          description: |
            Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:

            | Phase Value | Reason |
            |---|---|
            | CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |
            | FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |
            | FORGIVEN | Customer initiated payment which MongoDB later forgave. |
            | FREE | All charges totalled zero so the customer won't be charged. |
            | INVOICED | MongoDB handled these charges using elastic invoicing. |
            | PAID | MongoDB succeeded in charging the provided credit card. |
            | PENDING | Invoice includes charges for the current billing cycle. |
            | PREPAID | Customer has a pre-paid plan so they won't be charged. |
          enum:
          - PENDING
          - CLOSED
          - FORGIVEN
          - FAILED
          - PAID
          - FREE
          - PREPAID
          - INVOICED
        subtotalCents:
          type: integer
          format: int64
          description: Sum of all positive invoice line items contained in this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          readOnly: true
        updated:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud last updated the value of
            this payment. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          readOnly: true
    BillingPayment:
      type: object
      description: Funds transferred to MongoDB to cover the specified service in
        this invoice.
      properties:
        amountBilledCents:
          type: integer
          format: int64
          description: Sum of services that the specified organization consumed in
            the period covered in this invoice. This parameter expresses its value
            in cents (100ths of one US Dollar) and calculates its value as **subtotalCents**
            + **salesTaxCents** - **startingBalanceCents**.
          readOnly: true
        amountPaidCents:
          type: integer
          format: int64
          description: Sum that the specified organization paid toward the associated
            invoice. This parameter expresses its value in cents (100ths of one US
            Dollar).
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when the customer made this payment attempt.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this payment
            toward the associated invoice.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        salesTaxCents:
          type: integer
          format: int64
          description: Sum of sales tax applied to this invoice. This parameter expresses
            its value in cents (100ths of one US Dollar).
          readOnly: true
        statusName:
          type: string
          description: |
            Phase of payment processing for the associated invoice when you made this request.

            These phases include:

            | Phase Value | Reason |
            |---|---|
            | `CANCELLED` | Customer or MongoDB cancelled the payment. |
            | `ERROR` | Issue arose when attempting to complete payment. |
            | `FAILED` | MongoDB tried to charge the credit card without success. |
            | `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |
            | `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |
            | `INVOICED` | MongoDB issued an invoice that included this line item. |
            | `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |
            | `PAID` | Customer submitted a successful payment. |
            | `PARTIAL_PAID` | Customer paid for part of this line item. |
          enum:
          - NEW
          - FORGIVEN
          - FAILED
          - PAID
          - PARTIAL_PAID
          - CANCELLED
          - INVOICED
          - ERROR
          - FAILED_AUTHENTICATION
          - PROCESSING
          - PENDING_REVERSAL
          - REFUNDED
        subtotalCents:
          type: integer
          format: int64
          description: Sum of all positive invoice line items contained in this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          readOnly: true
        updated:
          type: string
          format: date-time
          description: Date and time when the customer made an update to this payment
            attempt. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          readOnly: true
      title: Payment
    BillingRefund:
      type: object
      description: One payment that MongoDB returned to the organization for this
        invoice.
      properties:
        amountCents:
          type: integer
          format: int64
          description: Sum of the funds returned to the specified organization expressed
            in cents (100th of US Dollar).
          readOnly: true
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created this refund. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          readOnly: true
        paymentId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the payment
            that the organization had made.
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        reason:
          type: string
          description: Justification that MongoDB accepted to return funds to the
            organization.
          readOnly: true
      title: Refund
    BillingThresholdAlertConfigViewForNdsGroup:
      type: object
      description: Billing threshold alert configuration allows to select thresholds
        for bills and invoices which trigger alerts and how users are notified.
      properties:
        created:
          type: string
          format: date-time
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
        enabled:
          type: boolean
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
        eventTypeName:
          $ref: '#/components/schemas/BillingEventTypeViewAlertableWithThreshold'
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        links:
          type: array
          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
        matchers:
          type: array
          description: No matchers are available for these alert types. The list is
            always empty.
          items:
            type: object
          readOnly: true
        notifications:
          type: array
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            $ref: '#/components/schemas/AlertsNotificationRootForGroup'
        threshold:
          $ref: '#/components/schemas/GreaterThanRawThreshold'
        updated:
          type: string
          format: date-time
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the <a href="https://en.wikipedia.org/wiki/ISO_8601"
            target="_blank" rel="noopener noreferrer">ISO 8601</a> timestamp format
            in UTC.
          readOnly: true
      required:
      - eventTypeName
      - notifications
      title: Billing Threshold Alert Configuration
    CloudAccessRoleAssignment:
      type: object
      description: MongoDB Cloud user's roles and the corresponding organization or
        project to which that role applies. Each role can apply to one organization
        or one project but not both.
      properties:
        groupId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the project
            to which this role belongs. You can set a value for this parameter or
            **orgId** but not both in the same request.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        orgId:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which this role belongs. You can set a value for this parameter or
            **groupId** but not both in the same request.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
        roleName:
          type: string
          description: |+
            Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.

            Organization Roles

            * ORG_OWNER
            * ORG_MEMBER
            * ORG_GROUP_CREATOR
            * ORG_BILLING_ADMIN
            * ORG_READ_ONLY

            Project Roles

            * GROUP_CLUSTER_MANAGER
            * GROUP_DATA_ACCESS_ADMIN
            * GROUP_DATA_ACCESS_READ_ONLY
            * GROUP_DATA_ACCESS_READ_WRITE
            * GROUP_OWNER
            * GROUP_READ_ONLY
            * GROUP_SEARCH_INDEX_EDITOR
            * GROUP_STREAM_PROCESSING_OWNER

          enum:
          - ORG_OWNER
          - ORG_MEMBER
          - ORG_GROUP_CREATOR
          - ORG_BILLING_ADMIN
          - ORG_READ_ONLY
          - GROUP_CLUSTER_MANAGER
          - GROUP_DATA_ACCESS_ADMIN
          - GROUP_DATA_ACCESS_READ_ONLY
          - GROUP_DATA_ACCESS_READ_WRITE
          - GROUP_OWNER
          - GROUP_READ_ONLY
          - GROUP_SEARCH_INDEX_EDITOR
          - GROUP_STREAM_PROCESSING_OWNER
      title: Role Assignment
    CloudAppUser:
      type: object
      properties:
        country:
          type: string
          description: Two alphabet characters that identifies MongoDB Cloud user's
            geographic location. This parameter uses the ISO 3166-1a2 code format.
          pattern: "^([A-Z]{2})$"
        createdAt:
          type: string
          format: date-time
          description: Date and time when the current account is created. This value
            is in the ISO 8601 timestamp format in UTC.
          readOnly: true
        emailAddress:
          type: string
          format: email
          deprecated: true
          description: Email address that belongs to the MongoDB Cloud user.
          readOnly: true
        firstName:
          type: string
          description: First or given name that belongs to the MongoDB Cloud user.
        id:
          type: string
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        lastAuth:
          type: string
          format: date-time
          description: Date and time when the current account last authenticated.
            This value is in the ISO 8601 timestamp format in UTC.
          readOnly: true
        lastName:
          type: string
          description: "Last name, family name, or surname that belongs to the MongoDB\
            \ Cloud user."
        links:
          type: array
          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
        mobileNumber:
          type: string
          description: Mobile phone number that belongs to the MongoDB Cloud user.
          pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\
            \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\
            s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$"
        password:
          type: string
          description: Password applied with the username to log in to MongoDB Cloud.
            MongoDB Cloud does not return this parameter except in response to creating
            a new MongoDB Cloud user. Only the MongoDB Cloud user can update their
            password after it has been set from the MongoDB Cloud console.
          minLength: 8
        roles:
          type: array
          description: List of objects that display the MongoDB Cloud user's roles
            and the corresponding organization or project to which that role applies.
            A role can apply to one organization or one project but not both.
          items:
            $ref: '#/components/schemas/CloudAccessRoleAssignment'
        teamIds:
          type: array
          description: List of unique 24-hexadecimal digit strings that identifies
            the teams to which this MongoDB Cloud user belongs.
          items:
            type: string
            description: Unique 24-hexadecimal digit string that identifies the team
              to which this MongoDB Cloud user belongs.
            example: 32b6e34b3d91647abb20e7b8
            maxLength: 24
            minLength: 24
            pattern: "^([a-f0-9]{24})$"
          readOnly: true
          uniqueItems: true
        username:
          type: string
          format: email
          description: Email address that represents the username of the MongoDB Cloud
            user.
      required:
      - country
      - emailAddress
      - firstName
      - lastName
      - mobileNumber
      - password
      - username
    CloudCluster:
      type: object
      description: Settings that describe the clusters in each project that the API
        key is authorized to view.
      properties:
        alertCount:
          type: integer
          format: int32
          description: Whole number that indicates the quantity of alerts open on
            the cluster.
          readOnly: true
        authEnabled:
          type: boolean
          description: Flag that indicates whether authentication is required to access
            the nodes in this cluster.
          readOnly: true
        availability:
          type: string
          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
        backupEnabled:
          type: boolean
          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
        clusterId:
          type: string
          description: Unique 24-hexadecimal character string that identifies the
            cluster.
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
        dataSizeBytes:
          type: integer
          format: int64
          description: Total size of the data stored on each node in the cluster.
            The resource expresses this value in bytes.
          readOnly: true
        name:
          type: string
          description: Human-readable label that identifies the cluster.
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
        nodeCount: