---
components:
  headers:
    HeaderRateLimitLimit:
      description: The maximum number of requests that a user can make within a specific
        time window.
      schema:
        type: integer
    HeaderRateLimitRemaining:
      description: The number of requests remaining in the current rate limit window
        before the limit is reached.
      schema:
        type: integer
    HeaderRetryAfter:
      description: The minimum time you should wait, in seconds, before retrying the
        API request. This header might be returned for 429 or 503 error responses.
      schema:
        type: integer
  parameters:
    collectionName:
      description: Human-readable label that identifies the collection.
      in: path
      name: collectionName
      required: true
      schema:
        example: mycoll
        type: string
    databaseName:
      description: Human-readable label that identifies the database.
      in: path
      name: databaseName
      required: true
      schema:
        example: mydb
        type: string
    end:
      description: Date and time when MongoDB Cloud stops reporting the metrics. This
        parameter expresses its value in the ISO 8601 timestamp format in UTC. Include
        this parameter when you do not set **period**.
      in: query
      name: end
      schema:
        format: date-time
        type: string
    envelope:
      description: Flag that indicates whether Application wraps the response in an
        `envelope` JSON object. Some API clients cannot access the HTTP response headers
        or status code. To remediate this, set envelope=true in the query. Endpoints
        that return a list of results use the results object as an envelope. Application
        adds the status parameter to the response body.
      in: query
      name: envelope
      schema:
        default: false
        type: boolean
    federationSettingsId:
      description: Unique 24-hexadecimal digit string that identifies your federation.
      in: path
      name: federationSettingsId
      required: true
      schema:
        example: 55fa922fb343282757d9554e
        pattern: "^([a-f0-9]{24})$"
        type: string
    granularity:
      description: Duration that specifies the interval at which Atlas reports the
        metrics. This parameter expresses its value in the ISO 8601 duration format
        in UTC.
      in: query
      name: granularity
      required: true
      schema:
        example: PT1M
        type: string
    groupId:
      description: |-
        Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

        **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
      in: path
      name: groupId
      required: true
      schema:
        example: 32b6e34b3d91647abb20e7b8
        pattern: "^([a-f0-9]{24})$"
        type: string
    identityProviderId:
      description: Legacy 20-hexadecimal digit string that identifies the identity
        provider. This id can be found within the Federation Management Console >
        Identity Providers tab by clicking the info icon in the IdP ID row of a configured
        identity provider.
      in: path
      name: identityProviderId
      required: true
      schema:
        example: c2777a9eca931f29fc2f
        pattern: "^([a-f0-9]{20})$"
        type: string
    includeCount:
      description: Flag that indicates whether the response returns the total number
        of items (`totalCount`) in the response.
      in: query
      name: includeCount
      schema:
        default: true
        type: boolean
    indexName:
      description: Human-readable label that identifies the index.
      in: path
      name: indexName
      required: true
      schema:
        example: myindex
        type: string
    itemsPerPage:
      description: Number of items that the response returns per page.
      in: query
      name: itemsPerPage
      schema:
        default: 100
        maximum: 500
        minimum: 1
        type: integer
    liveMigrationId:
      description: Unique 24-hexadecimal digit string that identifies the migration.
      in: path
      name: liveMigrationId
      required: true
      schema:
        example: 6296fb4c7c7aa997cf94e9a8
        pattern: "^([a-f0-9]{24})$"
        type: string
    orgId:
      description: Unique 24-hexadecimal digit string that identifies the organization
        that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations)
        endpoint to retrieve all organizations to which the authenticated user has
        access.
      in: path
      name: orgId
      required: true
      schema:
        example: 4888442a3354817a7320eb61
        pattern: "^([a-f0-9]{24})$"
        type: string
    pageNum:
      description: Number of the page that displays the current set of the total objects
        that the response returns.
      in: query
      name: pageNum
      schema:
        default: 1
        minimum: 1
        type: integer
    period:
      description: Duration over which Atlas reports the metrics. This parameter expresses
        its value in the ISO 8601 duration format in UTC. Include this parameter when
        you do not set **start** and **end**.
      in: query
      name: period
      schema:
        example: PT10H
        type: string
    pretty:
      description: Flag that indicates whether the response body should be in the
        prettyprint format.
      in: query
      name: pretty
      schema:
        default: false
        externalDocs:
          description: Prettyprint
          url: https://en.wikipedia.org/wiki/Prettyprint
        type: boolean
    processId:
      description: Combination of hostname and IANA port that serves the MongoDB process.
        The host must be the hostname, fully qualified domain name (FQDN), or Internet
        Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process
        (mongod or mongos). The port must be the IANA port on which the MongoDB process
        listens for requests.
      in: path
      name: processId
      required: true
      schema:
        example: my.host.name.com:27017
        pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
        type: string
    sandboxConfigId:
      description: Unique 24-hexadecimal digit string that identifies the sandbox
        configuration.
      in: path
      name: sandboxConfigId
      required: true
      schema:
        example: 507f1f77bcf86cd799439011
        pattern: "^([a-f0-9]{24})$"
        type: string
    start:
      description: Date and time when MongoDB Cloud begins reporting the metrics.
        This parameter expresses its value in the ISO 8601 timestamp format in UTC.
        Include this parameter when you do not set **period**.
      in: query
      name: start
      schema:
        format: date-time
        type: string
  responses:
    accepted:
      description: Accepted.
    badRequest:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint) No provider AWS exists."
            error: 400
            errorCode: VALIDATION_ERROR
            reason: Bad Request
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Bad Request.
    conflict:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint) Cannot delete organization link while there is active
              migration in following project ids: 60c4fd418ebe251047c50554"
            error: 409
            errorCode: CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK
            reason: Conflict
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Conflict.
    forbidden:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 403
            errorCode: CANNOT_CHANGE_GROUP_NAME
            reason: Forbidden
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Forbidden.
    gone:
      content:
        application/json:
          example:
            detail: This happens when a resource is marked for sunset and the sunset
              date is in the past.
            error: 410
            errorCode: VERSION_GONE
            reason: Gone
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Gone.
    internalServerError:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 500
            errorCode: UNEXPECTED_ERROR
            reason: Internal Server Error
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Internal Server Error.
    methodNotAllowed:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 405
            errorCode: ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED
            reason: Method Not Allowed
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Method Not Allowed.
    noBody:
      description: This endpoint does not return a response body.
    notFound:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint) Cannot find resource AWS"
            error: 404
            errorCode: RESOURCE_NOT_FOUND
            reason: Not Found
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Not Found.
    paymentRequired:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 402
            errorCode: NO_PAYMENT_INFORMATION_FOUND
            reason: Payment Required
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Payment Required.
    tooManyRequests:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 429
            errorCode: RATE_LIMITED
            reason: Too Many Requests
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Too Many Requests.
      headers:
        RateLimit-Limit:
          "$ref": "#/components/headers/HeaderRateLimitLimit"
        RateLimit-Remaining:
          "$ref": "#/components/headers/HeaderRateLimitRemaining"
        Retry-After:
          "$ref": "#/components/headers/HeaderRetryAfter"
    unauthorized:
      content:
        application/json:
          example:
            detail: "(This is just an example, the exception may not be related to
              this endpoint)"
            error: 401
            errorCode: NOT_ORG_GROUP_CREATOR
            reason: Unauthorized
          schema:
            "$ref": "#/components/schemas/ApiError"
      description: Unauthorized.
  schemas:
    AWSAccountDetails:
      properties:
        awsAccountId:
          description: The AWS Account ID.
          type: string
        cidrBlock:
          description: The VPC CIDR Block.
          type: string
        cloudProvider:
          description: Cloud provider.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        vpcId:
          description: The VPC ID.
          type: string
      type: object
    AWSCloudProviderContainer:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderContainer"
      - properties:
          atlasCidrBlock:
            description: |-
              IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

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

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

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

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

               **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.
            pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
            type: string
          regionName:
            description: Geographic area that Amazon Web Services (AWS) defines to
              which MongoDB Cloud deployed this network peering container.
            enum:
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - SA_EAST_1
            - AP_EAST_1
            - AP_EAST_2
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTH_1
            - AP_SOUTH_2
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_CENTRAL_1
            - ME_SOUTH_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            type: string
          vpcId:
            description: Unique string that identifies the MongoDB Cloud VPC on AWS.
            example: vpc-b555d3b0d9cb783b0
            pattern: "^vpc-[0-9a-f]{17}$"
            readOnly: true
            type: string
        type: object
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      required:
      - regionName
      title: AWS
      type: object
    AWSCloudProviderSettings:
      allOf:
      - "$ref": "#/components/schemas/ClusterProviderSettings"
      - properties:
          autoScaling:
            "$ref": "#/components/schemas/CloudProviderAWSAutoScaling"
          diskIOPS:
            description: Maximum Disk Input/Output Operations per Second (IOPS) that
              the database host can perform.
            format: int32
            type: integer
          encryptEBSVolume:
            default: true
            deprecated: true
            description: Flag that indicates whether the Amazon Elastic Block Store
              (EBS) encryption feature encrypts the host's root volume for both data
              at rest within the volume and for data moving between the volume and
              the cluster. Clusters always have this setting enabled.
            type: boolean
          instanceSizeName:
            description: Cluster tier, with a default storage and memory capacity,
              that applies to all the data-bearing hosts in your cluster.
            enum:
            - M10
            - M20
            - M30
            - M40
            - M50
            - M60
            - M80
            - M100
            - M140
            - M200
            - M300
            - R40
            - R50
            - R60
            - R80
            - R200
            - R300
            - R400
            - R700
            - M40_NVME
            - M50_NVME
            - M60_NVME
            - M80_NVME
            - M200_NVME
            - M400_NVME
            title: AWS Instance Sizes
            type: string
          regionName:
            description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_EAST_2
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_SOUTH_1
            - AP_SOUTH_2
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - ME_CENTRAL_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            externalDocs:
              description: AWS
              url: https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws
            title: AWS Regions
            type: string
          volumeType:
            description: Disk Input/Output Operations per Second (IOPS) setting for
              Amazon Web Services (AWS) storage that you configure only for AWS. Specify
              whether Disk Input/Output Operations per Second (IOPS) must not exceed
              the default Input/Output Operations per Second (IOPS) rate for the selected
              volume size (`STANDARD`), or must fall within the allowable Input/Output
              Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`).
              You must set this value to (`PROVISIONED`) for NVMe clusters.
            enum:
            - STANDARD
            - PROVISIONED
            type: string
        type: object
      type: object
    AWSComputeAutoScaling:
      description: Collection of settings that configures how a cluster might scale
        its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling
        is unavailable for clusters using Low CPU or NVME storage classes.
      properties:
        maxInstanceSize:
          description: Maximum instance size to which your cluster can automatically
            scale.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M100
          - M140
          - M200
          - M300
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - R700
          - M40_NVME
          - M50_NVME
          - M60_NVME
          - M80_NVME
          - M200_NVME
          - M400_NVME
          title: AWS Instance Sizes
          type: string
        minInstanceSize:
          description: Minimum instance size to which your cluster can automatically
            scale.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M100
          - M140
          - M200
          - M300
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - R700
          - M40_NVME
          - M50_NVME
          - M60_NVME
          - M80_NVME
          - M200_NVME
          - M400_NVME
          title: AWS Instance Sizes
          type: string
      title: AWS
      type: object
    AWSCreateDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/CreateDataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you wish to store your archived data.
            enum:
            - US_EAST_1
            - US_WEST_2
            - SA_EAST_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_CENTRAL_1
            - AP_SOUTH_1
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_NORTHEAST_2
            type: string
        type: object
      type: object
    AWSCustomDNSEnabledView:
      properties:
        enabled:
          description: |-
            Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).
            When `"enabled": true`, connect to your cluster using Private IP for Peering connection strings.
          externalDocs:
            description: 'To learn more, see FAQ: Connection String Options in the
              MongoDB Atlas documentation.'
            url: https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-
          type: boolean
      required:
      - enabled
      type: object
    AWSDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/DataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you store your archived data.
            enum:
            - US_EAST_1
            - US_WEST_2
            - SA_EAST_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_CENTRAL_1
            - AP_SOUTH_1
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_NORTHEAST_2
            readOnly: true
            type: string
        type: object
      type: object
    AWSHardwareSpec20240805:
      description: Hardware specifications for nodes deployed in the region.
      properties:
        diskIOPS:
          description: |-
            Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.

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

             Change this parameter if you:

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

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

            The maximum input/output operations per second (IOPS) depend on the selected `.instanceSize` and `.diskSizeGB`.
            This parameter defaults to the cluster tier's standard IOPS value.
            Changing this value impacts cluster cost.
            MongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.

            - Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.
            - Instance sizes greater than `M40` have a ratio of 120:1.
          format: int32
          type: integer
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value must be equal for
            all shards and node types.\n\n This value is not configurable on M0/M2/M5
            clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n
            If you specify a disk size below the minimum (10 GB), this parameter defaults
            to the minimum disk size value. \n\n Storage charge calculations depend
            on whether you choose the default value or a custom value.\n\n The maximum
            value for disk storage cannot exceed 50 times the maximum RAM for the
            selected cluster. If you require more storage space, consider upgrading
            your cluster to a higher tier."
          externalDocs:
            description: Customize Storage
            url: https://dochub.mongodb.org/core/customize-storage
          format: double
          type: number
        ebsVolumeType:
          default: STANDARD
          description: "Type of storage you want to attach to your AWS-provisioned
            cluster.\n\n- `STANDARD` volume types can't exceed the default input/output
            operations per second (IOPS) rate for the selected volume size. \n\n-
            `PROVISIONED` volume types must fall within the allowable IOPS range for
            the selected volume size. You must set this value to (`PROVISIONED`) for
            NVMe clusters."
          enum:
          - STANDARD
          - PROVISIONED
          type: string
        instanceSize:
          description: Hardware specification for the instance sizes in this region
            in this shard. Each instance size has a default storage and memory capacity.
            Electable nodes and read-only nodes (known as "base nodes") within a single
            shard must use the same instance size. Analytics nodes can scale independently
            from base nodes within a shard. Both base nodes and analytics nodes can
            scale independently from their equivalents in other shards.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M100
          - M140
          - M200
          - M300
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - R700
          - M40_NVME
          - M50_NVME
          - M60_NVME
          - M80_NVME
          - M200_NVME
          - M400_NVME
          title: AWS Instance Sizes
          type: string
        nodeCount:
          description: Number of nodes of the given type for MongoDB Cloud to deploy
            to the region.
          format: int32
          type: integer
      title: AWS Cluster Hardware Settings
      type: object
    AWSInterfaceEndpoint:
      description: Group of Private Endpoint settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        connectionStatus:
          description: State of the Amazon Web Service PrivateLink connection when
            MongoDB Cloud received this request.
          enum:
          - PENDING_ACCEPTANCE
          - PENDING
          - AVAILABLE
          - REJECTED
          - DELETING
          readOnly: true
          type: string
        deleteRequested:
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
          type: boolean
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        interfaceEndpointId:
          description: Unique 24-hexadecimal digit string that identifies the interface
            endpoint.
          readOnly: true
          type: string
      required:
      - cloudProvider
      title: AWS
      type: object
    AWSKMSConfiguration:
      description: Amazon Web Services (AWS) KMS configuration details and encryption
        at rest configuration set for the specified project.
      externalDocs:
        description: Amazon Web Services Key Management Service
        url: https://www.mongodb.com/docs/atlas/security-aws-kms/
      properties:
        accessKeyID:
          description: Unique alphanumeric string that identifies an Identity and
            Access Management (IAM) access key with permissions required to access
            your Amazon Web Services (AWS) Customer Master Key (CMK).
          example: '019dd98d94b4bb778e7552e4'
          maxLength: 128
          minLength: 16
          type: string
        customerMasterKeyID:
          description: Unique alphanumeric string that identifies the Amazon Web Services
            (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB
            master keys.
          maxLength: 2048
          minLength: 1
          type: string
        enabled:
          description: Flag that indicates whether someone enabled encryption at rest
            for the specified project through Amazon Web Services (AWS) Key Management
            Service (KMS). To disable encryption at rest using customer key management
            and remove the configuration details, pass only this parameter with a
            value of `false`.
          type: boolean
        region:
          description: Physical location where MongoDB Cloud deploys your AWS-hosted
            MongoDB cluster nodes. The region you choose can affect network latency
            for clients accessing your databases. When MongoDB Cloud deploys a dedicated
            cluster, it checks if a VPC or VPC connection exists for that provider
            and region. If not, MongoDB Cloud creates them as part of the deployment.
            MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
            connection to one CIDR block and region, create the connection first.
            Deploy the cluster after the connection starts.
          enum:
          - US_GOV_WEST_1
          - US_GOV_EAST_1
          - US_EAST_1
          - US_EAST_2
          - US_WEST_1
          - US_WEST_2
          - CA_CENTRAL_1
          - EU_NORTH_1
          - EU_WEST_1
          - EU_WEST_2
          - EU_WEST_3
          - EU_CENTRAL_1
          - EU_CENTRAL_2
          - AP_EAST_1
          - AP_EAST_2
          - AP_NORTHEAST_1
          - AP_NORTHEAST_2
          - AP_NORTHEAST_3
          - AP_SOUTHEAST_1
          - AP_SOUTHEAST_2
          - AP_SOUTHEAST_3
          - AP_SOUTHEAST_4
          - AP_SOUTHEAST_5
          - AP_SOUTHEAST_6
          - AP_SOUTHEAST_7
          - AP_SOUTH_1
          - AP_SOUTH_2
          - SA_EAST_1
          - CN_NORTH_1
          - CN_NORTHWEST_1
          - ME_SOUTH_1
          - ME_CENTRAL_1
          - AF_SOUTH_1
          - EU_SOUTH_1
          - EU_SOUTH_2
          - IL_CENTRAL_1
          - CA_WEST_1
          - MX_CENTRAL_1
          - GLOBAL
          title: AWS Regions
          type: string
        requirePrivateNetworking:
          description: Enable connection to your Amazon Web Services (AWS) Key Management
            Service (KMS) over private networking.
          type: boolean
        roleId:
          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
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
        secretAccessKey:
          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.
          type: string
          writeOnly: true
        valid:
          description: Flag that indicates whether the Amazon Web Services (AWS) Key
            Management Service (KMS) encryption key can encrypt and decrypt data.
          readOnly: true
          type: boolean
      type: object
    AWSKMSEARPrivateEndpoint:
      description: AWS Key Management Service Encryption At Rest Private Endpoint.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider for
            the Encryption At Rest private endpoint.
          enum:
          - AZURE
          - AWS
          readOnly: true
          type: string
        errorMessage:
          description: Error message for failures associated with the Encryption At
            Rest private endpoint.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        privateEndpointConnectionName:
          description: Resource Id of the Aws Private Endpoint.
          readOnly: true
          type: string
        regionName:
          description: Cloud provider region in which the Encryption At Rest private
            endpoint is located.
          oneOf:
          - description: Microsoft Azure Regions.
            enum:
            - US_CENTRAL
            - US_EAST
            - US_EAST_2
            - US_NORTH_CENTRAL
            - US_WEST
            - US_SOUTH_CENTRAL
            - EUROPE_NORTH
            - EUROPE_WEST
            - US_WEST_CENTRAL
            - US_WEST_2
            - US_WEST_3
            - CANADA_EAST
            - CANADA_CENTRAL
            - BRAZIL_SOUTH
            - BRAZIL_SOUTHEAST
            - AUSTRALIA_CENTRAL
            - AUSTRALIA_CENTRAL_2
            - AUSTRALIA_EAST
            - AUSTRALIA_SOUTH_EAST
            - GERMANY_WEST_CENTRAL
            - GERMANY_NORTH
            - SWEDEN_CENTRAL
            - SWEDEN_SOUTH
            - SWITZERLAND_NORTH
            - SWITZERLAND_WEST
            - UK_SOUTH
            - UK_WEST
            - NORWAY_EAST
            - NORWAY_WEST
            - INDIA_CENTRAL
            - INDIA_SOUTH
            - INDIA_WEST
            - CHINA_EAST
            - CHINA_NORTH
            - ASIA_EAST
            - JAPAN_EAST
            - JAPAN_WEST
            - ASIA_SOUTH_EAST
            - KOREA_CENTRAL
            - KOREA_SOUTH
            - FRANCE_CENTRAL
            - FRANCE_SOUTH
            - SOUTH_AFRICA_NORTH
            - SOUTH_AFRICA_WEST
            - UAE_CENTRAL
            - UAE_NORTH
            - QATAR_CENTRAL
            - POLAND_CENTRAL
            - ISRAEL_CENTRAL
            - ITALY_NORTH
            - SPAIN_CENTRAL
            - MEXICO_CENTRAL
            - NEW_ZEALAND_NORTH
            - US_GOV_VIRGINIA
            - US_GOV_ARIZONA
            - US_GOV_TEXAS
            title: Azure Regions
            type: string
          - description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_EAST_2
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_SOUTH_1
            - AP_SOUTH_2
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - ME_CENTRAL_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            title: AWS Regions
            type: string
          type: object
        status:
          description: State of the Encryption At Rest private endpoint.
          enum:
          - INITIATING
          - PENDING_ACCEPTANCE
          - ACTIVE
          - FAILED
          - PENDING_RECREATION
          - DELETING
          readOnly: true
          type: string
      title: AWS Key Management Service EAR Private Endpoint
      type: object
    AWSPrivateLinkConnection:
      description: Group of Private Endpoint Service settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        endpointServiceName:
          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
          type: string
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        interfaceEndpoints:
          description: List of strings that identify private endpoint interfaces applied
            to the specified project.
          items:
            description: Unique 24-hexadecimal digit string that identifies the interface
              endpoint.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          readOnly: true
          type: array
        regionName:
          description: Cloud provider region that manages this Private Endpoint Service.
          readOnly: true
          type: string
        status:
          description: State of the Private Endpoint Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - WAITING_FOR_USER
          - FAILED
          - DELETING
          readOnly: true
          type: string
        supportedRemoteRegions:
          description: List of regions that the endpoint service supports. Native
            cross region support is implemented for AWS only.
          items:
            description: AWS region name
            type: string
          maxItems: 35
          nullable: true
          type: array
      required:
      - cloudProvider
      - interfaceEndpoints
      title: AWS
      type: object
    AWSRegionConfig20240805:
      allOf:
      - "$ref": "#/components/schemas/CloudRegionConfig20240805"
      - properties:
          analyticsAutoScaling:
            "$ref": "#/components/schemas/AdvancedAutoScalingSettings"
          analyticsSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          autoScaling:
            "$ref": "#/components/schemas/AdvancedAutoScalingSettings"
          effectiveAnalyticsSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          effectiveElectableSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          effectiveReadOnlySpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          readOnlySpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
        type: object
      description: Details that explain how MongoDB Cloud replicates data in one region
        on the specified MongoDB database.
      title: AWS Regional Replication Specifications
      type: object
    AccessListItemView:
      properties:
        cidrBlock:
          description: Range of IP addresses in Classless Inter-Domain Routing (CIDR)
            notation that found in this project's access list.
          pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
          readOnly: true
          type: string
        ipAddress:
          description: IP address included in the API access list.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
          type: string
      required:
      - ipAddress
      type: object
    AccountDetails:
      description: Account details for the group, region, and provider.
      discriminator:
        mapping:
          aws: "#/components/schemas/AWSAccountDetails"
          azure: "#/components/schemas/AzureAccountDetails"
          gcp: "#/components/schemas/GCPAccountDetails"
        propertyName: cloudProvider
      oneOf:
      - "$ref": "#/components/schemas/AWSAccountDetails"
      - "$ref": "#/components/schemas/AzureAccountDetails"
      - "$ref": "#/components/schemas/GCPAccountDetails"
      type: object
    AcknowledgeAlert:
      description: Acknowledging an alert prevents successive notifications. Specify
        the `acknowledgeUntil` date and optional comment or `unacknowledgeAlert` boolean.
      properties:
        acknowledgedUntil:
          description: Date and time until which this alert has been acknowledged.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter if a MongoDB User previously
            acknowledged this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        unacknowledgeAlert:
          description: Flag that indicates to unacknowledge a previously acknowledged
            alert. By default this value is set to false. If set to true, it will
            override the `acknowledgedUntil` parameter.
          type: boolean
      title: Acknowledge Alert
      type: object
    ActivityFeedLinkResponse:
      description: Response containing a shareable activity feed link.
      properties:
        link:
          description: Shareable link to the activity feed with pre-applied filters.
          example: https://cloud.mongodb.com/redirect/1234567890abcdef12345678
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      required:
      - link
      type: object
    AddOrRemoveGroupRole:
      properties:
        groupRole:
          description: Project-level role to assign to or remove from the MongoDB
            Cloud user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          type: string
      required:
      - groupRole
      type: object
    AddOrRemoveOrgRole:
      properties:
        orgRole:
          description: Organization-level role.
          enum:
          - ORG_OWNER
          - ORG_GROUP_CREATOR
          - ORG_BILLING_ADMIN
          - ORG_BILLING_READ_ONLY
          - ORG_STREAM_PROCESSING_ADMIN
          - ORG_READ_ONLY
          - ORG_MEMBER
          type: string
      required:
      - orgRole
      type: object
    AddOrRemoveUserFromTeam:
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
      required:
      - id
      type: object
    AddUserToTeam:
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      required:
      - id
      type: object
    AdvancedAutoScalingSettings:
      description: Options that determine how this cluster handles resource scaling.
      properties:
        compute:
          "$ref": "#/components/schemas/AdvancedComputeAutoScaling"
        diskGB:
          "$ref": "#/components/schemas/DiskGBAutoScaling"
      title: Automatic Scaling Settings
      type: object
    AdvancedComputeAutoScaling:
      description: Options that determine how this cluster handles CPU scaling.
      properties:
        enabled:
          description: |-
            Flag that indicates whether instance size reactive auto-scaling is enabled.

            - Set to `true` to enable instance size reactive auto-scaling. If enabled, you must specify a value for `replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize`.
            - Set to `false` to disable instance size reactive auto-scaling.
          type: boolean
        maxInstanceSize:
          "$ref": "#/components/schemas/BaseCloudProviderInstanceSize"
        minInstanceSize:
          "$ref": "#/components/schemas/BaseCloudProviderInstanceSize"
        scaleDownEnabled:
          description: Flag that indicates whether the instance size may scale down
            via reactive auto-scaling. MongoDB Cloud requires this parameter if `replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled`
            is `true`. If you enable this option, specify a value for `replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize`.
          type: boolean
      title: Automatic Compute Scaling Settings
      type: object
    AdvancedDiskBackupSnapshotSchedulePolicy:
      description: List that contains a document for each backup policy item in the
        desired backup policy.
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        policyItems:
          description: List that contains the specifications for one policy.
          items:
            "$ref": "#/components/schemas/DiskBackupApiPolicyItem"
          type: array
      required:
      - policyItems
      type: object
    AlertAudit:
      description: Alert audit indicates acknowledgement status of an alert.
      properties:
        alertId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/AlertAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Alert Audits
      type: object
    AlertAuditTypeView:
      description: Unique identifier of event type.
      enum:
      - ALERT_ACKNOWLEDGED_AUDIT
      - ALERT_UNACKNOWLEDGED_AUDIT
      example: ALERT_ACKNOWLEDGED_AUDIT
      title: Alert Audit Types
      type: string
    AlertConfigAudit:
      description: Alert configuration audit indicates any activities around alert
        settings.
      properties:
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration associated with the `alertId`.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/AlertConfigAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Alert Config Audits
      type: object
    AlertConfigAuditTypeView:
      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
      type: string
    AlertMatcher:
      description: Rules to apply when comparing an target instance against this alert
        configuration.
      properties:
        fieldName:
          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.
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value against **matcher[n].value**. The `REGEX` operator only supports
            inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
          type: string
        value:
          description: Value to match or exceed using the specified `matchers.operator`.
          example: event-replica-set
          type: string
      required:
      - fieldName
      - operator
      - value
      title: Matchers
      type: object
    AlertViewForNdsGroup:
      oneOf:
      - "$ref": "#/components/schemas/AppServiceAlertView"
      - "$ref": "#/components/schemas/ClusterAlertViewForNdsGroup"
      - "$ref": "#/components/schemas/HostAlertViewForNdsGroup"
      - "$ref": "#/components/schemas/HostMetricAlert"
      - "$ref": "#/components/schemas/ReplicaSetAlertViewForNdsGroup"
      - "$ref": "#/components/schemas/StreamProcessorAlertViewForNdsGroup"
      - "$ref": "#/components/schemas/DefaultAlertViewForNdsGroup"
      type: object
    AlertsNotificationRootForGroup:
      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"
      type: object
    AlertsThresholdInteger:
      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:
          description: Value of metric that, when exceeded, triggers an alert.
          format: int32
          type: integer
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      title: Threshold
      type: object
    AlertsToggle:
      description: Enables or disables the specified alert configuration in the specified
        project.
      properties:
        enabled:
          description: Flag that indicates whether to enable or disable the specified
            alert configuration in the specified project.
          type: boolean
      title: Toggle Request
      type: object
    ApiAtlasCheckpointView:
      properties:
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the cluster
            that contains the checkpoint.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        completed:
          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.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns the checkpoints.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies checkpoint.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        parts:
          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
          type: array
        restorable:
          description: Flag that indicates whether MongoDB Cloud can use the checkpoint
            for a restore.
          readOnly: true
          type: boolean
        started:
          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.
          format: date-time
          readOnly: true
          type: string
        timestamp:
          description: Date and time to which the checkpoint restores. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
      type: object
    ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView:
      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
      type: object
    ApiAtlasClusterAdvancedConfigurationView:
      description: Group of settings that configures a subset of the advanced configuration
        details.
      properties:
        customOpensslCipherConfigTls12:
          description: The custom OpenSSL cipher suite list for TLS 1.2. This field
            is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
          externalDocs:
            description: This option corresponds to the `opensslCipherConfig` `mongod`
              configuration file option.
            url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherConfig
          items:
            enum:
            - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
            - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
            type: string
          type: array
        customOpensslCipherConfigTls13:
          description: The custom OpenSSL cipher suite list for TLS 1.3. This field
            is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
          externalDocs:
            description: This option corresponds to the `opensslCipherSuiteConfig`
              `mongod` configuration file option.
            url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherSuiteConfig
          items:
            enum:
            - TLS_AES_256_GCM_SHA384
            - TLS_CHACHA20_POLY1305_SHA256
            - TLS_AES_128_GCM_SHA256
            - TLS_AES_128_CCM_SHA256
            type: string
          maxItems: 4
          type: array
        minimumEnabledTlsProtocol:
          description: Minimum Transport Layer Security (TLS) version that the cluster
            accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should
            consider setting TLS 1.2 as the minimum TLS protocol version.
          enum:
          - TLS1_0
          - TLS1_1
          - TLS1_2
          - TLS1_3
          externalDocs:
            description: This option corresponds to the `net.ssl.disabledProtocols`
              `mongod` configuration file option.
            url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols
          type: string
        tlsCipherConfigMode:
          description: The TLS cipher suite configuration mode. The default mode uses
            the default cipher suites. The custom mode allows you to specify custom
            cipher suites for both TLS 1.2 and TLS 1.3.
          enum:
          - CUSTOM
          - DEFAULT
          type: string
      type: object
    ApiAtlasDataLakeAWSRegionView:
      description: Atlas Data Federation AWS Regions.
      enum:
      - SYDNEY_AUS
      - MUMBAI_IND
      - FRANKFURT_DEU
      - DUBLIN_IRL
      - LONDON_GBR
      - VIRGINIA_USA
      - OREGON_USA
      - SAOPAULO_BRA
      - MONTREAL_CAN
      - TOKYO_JPN
      - SEOUL_KOR
      - SINGAPORE_SGP
      type: string
    ApiAtlasFTSAnalyzersViewManual:
      description: Settings that describe one Atlas Search custom analyzer.
      properties:
        charFilters:
          description: Filters that examine text one character at a time and perform
            filtering operations.
          items:
            oneOf:
            - "$ref": "#/components/schemas/charFilterhtmlStrip"
            - "$ref": "#/components/schemas/charFiltericuNormalize"
            - "$ref": "#/components/schemas/charFiltermapping"
            - "$ref": "#/components/schemas/charFilterpersian"
            type: object
          type: array
        name:
          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.`
          type: string
        tokenFilters:
          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/TokenFilterEnglishPossessive"
            - "$ref": "#/components/schemas/TokenFilterFlattenGraph"
            - "$ref": "#/components/schemas/tokenFiltericuFolding"
            - "$ref": "#/components/schemas/tokenFiltericuNormalizer"
            - "$ref": "#/components/schemas/TokenFilterkStemming"
            - "$ref": "#/components/schemas/tokenFilterlength"
            - "$ref": "#/components/schemas/tokenFilterlowercase"
            - "$ref": "#/components/schemas/tokenFilternGram"
            - "$ref": "#/components/schemas/TokenFilterPorterStemming"
            - "$ref": "#/components/schemas/tokenFilterregex"
            - "$ref": "#/components/schemas/tokenFilterreverse"
            - "$ref": "#/components/schemas/tokenFiltershingle"
            - "$ref": "#/components/schemas/tokenFiltersnowballStemming"
            - "$ref": "#/components/schemas/TokenFilterSpanishPluralStemming"
            - "$ref": "#/components/schemas/TokenFilterStempel"
            - "$ref": "#/components/schemas/tokenFilterstopword"
            - "$ref": "#/components/schemas/tokenFiltertrim"
            - "$ref": "#/components/schemas/TokenFilterWordDelimiterGraph"
          type: array
        tokenizer:
          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"
          type: object
      required:
      - name
      - tokenizer
      title: analyzers
      type: object
    ApiAtlasFTSMappingsViewManual:
      description: Index specifications for the collection's fields.
      properties:
        dynamic:
          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://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples
          type: boolean
        fields:
          additionalProperties:
            externalDocs:
              description: Atlas Search Field Mappings
              url: https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings
            type: object
          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://dochub.mongodb.org/core/index-definitions-fts
          type: object
      title: mappings
      type: object
    ApiAtlasInvalidPolicyErrorDetailView:
      properties:
        detail:
          description: A string that provides a detailed description of a validation
            error.
          readOnly: true
          type: string
      type: object
    ApiAtlasInvalidPolicyView:
      properties:
        body:
          description: A string that defines the permissions for the policy. The syntax
            used is the Cedar Policy language.
          example: |2
              forbid (
                principal,
                action == cloud::Action::"cluster.createEdit",
                resource
              ) when {
               context.cluster.regions.contains(cloud::region::"aws:us-east-1")
              };
          readOnly: true
          type: string
        errors:
          description: List of validation errors.
          items:
            "$ref": "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView"
          readOnly: true
          type: array
      type: object
    ApiAtlasInvalidResourcePolicyCreateErrorView:
      properties:
        errorType:
          description: Human-readable label that displays the type of an error.
          enum:
          - POLICY_PARSING_ERROR
          - POLICY_HAS_FAILED_VALIDATIONS
          - POLICY_HAS_INVALID_PRINCIPAL
          - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE
          - POLICY_HAS_UNEXPECTED_ENTITIES
          type: string
        invalidPolicies:
          description: List of invalid policies containing details of their validation
            errors.
          items:
            "$ref": "#/components/schemas/ApiAtlasInvalidPolicyView"
          readOnly: true
          type: array
      type: object
    ApiAtlasModifyEndpointServiceRequestView:
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud service provider
            for the private endpoint service which you want to update.
          enum:
          - AWS
          type: string
        supportedRemoteRegions:
          description: List of regions that the endpoint service supports. Native
            cross region support is implemented for AWS only.
          items:
            description: AWS region name
            type: string
          maxItems: 35
          nullable: true
          type: array
      required:
      - cloudProvider
      type: object
    ApiAtlasNonCompliantResourceView:
      properties:
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization the resource belongs to.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resourceId:
          description: Unique 24-hexadecimal character string that identifies the
            non-compliant resource.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resourceName:
          description: Unique human readable string that identifies the non-compliant
            resource.
          readOnly: true
          type: string
        resourcePoliciesCausingNonCompliance:
          description: List of resource policies causing the resource to be considered
            non-compliant.
          items:
            "$ref": "#/components/schemas/ApiAtlasResourcePolicyMetadataView"
          readOnly: true
          type: array
        resourceType:
          description: Human-readable label that displays the type of a resource.
          enum:
          - DEPRECATED_PROJECT
          - DEPRECATED_CLUSTER
          - PROJECT
          - CLUSTER
          readOnly: true
          type: string
      type: object
    ApiAtlasPolicyCreateView:
      properties:
        body:
          description: A string that defines the permissions for the policy. The syntax
            used is the Cedar Policy language.
          example: |2
              forbid (
                principal,
                action == cloud::Action::"cluster.createEdit",
                resource
              ) when {
               context.cluster.regions.contains(cloud::region::"aws:us-east-1")
              };
          minLength: 1
          type: string
      required:
      - body
      type: object
    ApiAtlasPolicyMetadataView:
      properties:
        policyId:
          description: Unique 24-hexadecimal character string that identifies the
            policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      type: object
    ApiAtlasPolicyView:
      properties:
        body:
          description: A string that defines the permissions for the policy. The syntax
            used is the Cedar Policy language.
          example: |2
              forbid (
                principal,
                action == cloud::Action::"cluster.createEdit",
                resource
              ) when {
               context.cluster.regions.contains(cloud::region::"aws:us-east-1")
              };
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      type: object
    ApiAtlasResourcePolicyCreateView:
      properties:
        description:
          description: Description of the atlas resource policy.
          type: string
        name:
          description: Human-readable label that describes the atlas resource policy.
          type: string
        policies:
          description: List of policies that make up the atlas resource policy.
          items:
            "$ref": "#/components/schemas/ApiAtlasPolicyCreateView"
          type: array
      required:
      - name
      - policies
      type: object
    ApiAtlasResourcePolicyEditView:
      properties:
        description:
          description: Description of the atlas resource policy.
          type: string
        name:
          description: Human-readable label that describes the atlas resource policy.
          type: string
        policies:
          description: List of policies that make up the atlas resource policy.
          items:
            "$ref": "#/components/schemas/ApiAtlasPolicyCreateView"
          type: array
      type: object
    ApiAtlasResourcePolicyMetadataView:
      properties:
        policiesCausingNonCompliance:
          description: List of policies that are in conflict with the current state
            of the resource.
          items:
            "$ref": "#/components/schemas/ApiAtlasPolicyMetadataView"
          readOnly: true
          type: array
        resourcePolicyId:
          description: Unique 24-hexadecimal character string that identifies the
            atlas resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resourcePolicyName:
          description: Human-readable label that describes the atlas resource policy.
          readOnly: true
          type: string
      type: object
    ApiAtlasResourcePolicyView:
      properties:
        createdByUser:
          "$ref": "#/components/schemas/ApiAtlasUserMetadataView"
        createdDate:
          description: Date and time in UTC when the atlas resource policy was created.
          format: date-time
          readOnly: true
          type: string
        description:
          description: Description of the atlas resource policy.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            atlas resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastUpdatedByUser:
          "$ref": "#/components/schemas/ApiAtlasUserMetadataView"
        lastUpdatedDate:
          description: Date and time in UTC when the atlas resource policy was last
            updated.
          format: date-time
          readOnly: true
          type: string
        name:
          description: Human-readable label that describes the atlas resource policy.
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization the atlas resource policy belongs to.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        policies:
          description: List of policies that make up the atlas resource policy.
          items:
            "$ref": "#/components/schemas/ApiAtlasPolicyView"
          readOnly: true
          type: array
        version:
          description: A string that identifies the version of the atlas resource
            policy.
          example: v1
          readOnly: true
          type: string
      type: object
    ApiAtlasSnapshotScheduleView:
      properties:
        clusterCheckpointIntervalMin:
          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
          format: int32
          type: integer
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshot you want to return.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        dailySnapshotRetentionDays:
          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
          format: int32
          type: integer
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        monthlySnapshotRetentionMonths:
          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
          format: int32
          type: integer
        pointInTimeWindowHours:
          description: Number of hours before the current time from which MongoDB
            Cloud can create a Continuous Cloud Backup snapshot.
          format: int32
          type: integer
        snapshotIntervalHours:
          description: Number of hours that must elapse before taking another snapshot.
          enum:
          - 6
          - 8
          - 12
          - 24
          format: int32
          type: integer
        snapshotRetentionDays:
          description: Number of days that MongoDB Cloud must keep recent snapshots.
          enum:
          - 2
          - 3
          - 4
          - 5
          format: int32
          type: integer
        weeklySnapshotRetentionWeeks:
          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
          format: int32
          type: integer
      required:
      - clusterCheckpointIntervalMin
      - clusterId
      - dailySnapshotRetentionDays
      - groupId
      - monthlySnapshotRetentionMonths
      - pointInTimeWindowHours
      - snapshotIntervalHours
      - snapshotRetentionDays
      - weeklySnapshotRetentionWeeks
      type: object
    ApiAtlasUserMetadataView:
      description: The user that last updated the atlas resource policy.
      properties:
        id:
          description: Unique 24-hexadecimal character string that identifies a user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        name:
          description: Human-readable label that describes a user.
          readOnly: true
          type: string
      readOnly: true
      type: object
    ApiBSONTimestampView:
      description: BSON timestamp that indicates when the checkpoint token entry in
        the oplog occurred.
      properties:
        date:
          description: Date and time when the oplog recorded this database operation.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        increment:
          description: Order of the database operation that the oplog recorded at
            specific date and time.
          example: 1199145600
          format: int32
          minimum: 1199145600
          readOnly: true
          type: integer
      readOnly: true
      title: BSON Timestamp
      type: object
    ApiCheckpointPartView:
      description: Metadata contained in one document that describes the complete
        snapshot taken for this node.
      properties:
        replicaSetName:
          description: Human-readable label that identifies the replica set to which
            this checkpoint applies.
          readOnly: true
          type: string
        shardName:
          description: Human-readable label that identifies the shard to which this
            checkpoint applies.
          readOnly: true
          type: string
        tokenDiscovered:
          description: Flag that indicates whether the token exists.
          readOnly: true
          type: boolean
        tokenTimestamp:
          "$ref": "#/components/schemas/ApiBSONTimestampView"
        typeName:
          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
          type: string
      readOnly: true
      type: object
    ApiError:
      properties:
        badRequestDetail:
          "$ref": "#/components/schemas/BadRequestDetail"
        detail:
          description: Describes the specific conditions or reasons that cause each
            type of error.
          type: string
        error:
          description: HTTP status code returned with this error.
          externalDocs:
            url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
          format: int32
          readOnly: true
          type: integer
        errorCode:
          description: Application error code returned with this error.
          readOnly: true
          type: string
        parameters:
          description: Parameters used to give more information about the error.
          items:
            type: object
          readOnly: true
          type: array
        reason:
          description: Application error message returned with this error.
          readOnly: true
          type: string
      required:
      - error
      - errorCode
      type: object
    ApiHostView_Atlas:
      properties:
        created:
          description: Date and time when MongoDB Cloud created this MongoDB process.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostname:
          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
          type: string
        id:
          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
          type: string
        lastPing:
          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.
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link_Atlas"
          readOnly: true
          type: array
        port:
          description: Internet Assigned Numbers Authority (IANA) port on which the
            MongoDB process listens for requests.
          format: int32
          readOnly: true
          type: integer
        replicaSetName:
          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
          type: string
        shardName:
          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
          type: string
        typeName:
          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
          type: string
        userAlias:
          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
          type: string
        version:
          description: Version of MongoDB that this process runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
      type: object
    ApiKey:
      description: Details contained in one API key.
      nullable: true
      properties:
        accessList:
          description: List of network addresses granted access to this API using
            this API key.
          items:
            "$ref": "#/components/schemas/AccessListItemView"
          readOnly: true
          type: array
        id:
          description: Unique 24-hexadecimal digit string that identifies this organization
            API key.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public API key value set for the specified organization API
            key.
          maxLength: 8
          minLength: 8
          readOnly: true
          type: string
        roles:
          description: List that contains roles that the API key needs to have. All
            roles you provide must be valid for the specified project or organization.
            Each request must include a minimum of one valid role. The resource returns
            all project and organization roles assigned to the Cloud user.
          items:
            "$ref": "#/components/schemas/CloudAccessRoleAssignment"
          readOnly: true
          type: array
      readOnly: true
      required:
      - accessList
      - id
      - publicKey
      - roles
      type: object
    ApiKeyUserDetails:
      description: Details of the Programmatic API Keys.
      properties:
        desc:
          description: Purpose or explanation provided when someone created this organization
            API key.
          maxLength: 250
          minLength: 1
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this organization
            API key assigned to this project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        privateKey:
          description: Redacted private key returned for this organization API key.
            This key displays unredacted when first created.
          example: 55c3bbb6-b4bb-0be1-e66d20841f3e
          readOnly: true
          type: string
        publicKey:
          description: Public API key value set for the specified organization API
            key.
          example: zmmrboas
          maxLength: 8
          minLength: 8
          readOnly: true
          type: string
        roles:
          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"
          type: array
      type: object
    ApiMeasurementsGeneralView_Atlas:
      properties:
        databaseName:
          description: Human-readable label that identifies the database that the
            specified MongoDB process serves.
          readOnly: true
          type: string
        end:
          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.
          format: date-time
          readOnly: true
          type: string
        granularity:
          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
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostId:
          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
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link_Atlas"
          readOnly: true
          type: array
        measurements:
          description: List that contains measurements and their data points.
          items:
            "$ref": "#/components/schemas/MetricsMeasurement_Atlas"
          readOnly: true
          type: array
        partitionName:
          description: Human-readable label of the disk or partition to which the
            measurements apply.
          readOnly: true
          type: string
        processId:
          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
          type: string
        start:
          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.
          format: date-time
          readOnly: true
          type: string
      type: object
    ApiPrivateDownloadDeliveryUrl:
      description: One Uniform Resource Locator (URL) that points to the compressed
        snapshot files for manual download and the corresponding private endpoint.
      properties:
        deliveryUrl:
          description: One Uniform Resource Locator that points to the compressed
            snapshot files for manual download.
          type: string
        endpointId:
          description: Unique 22-character alphanumeric string that identifies the
            private endpoint.
          example: vpce-3bf78b0ddee411ba1
          pattern: "^vpce-[0-9a-f]{17}$"
          type: string
      type: object
    ApiPublicUsageDetailsQueryRequest:
      description: Request body for an Invoice Usage Details query with filtering,
        pagination, and sort.
      properties:
        filters:
          "$ref": "#/components/schemas/UsageDetailsFilterRequest"
        sortField:
          description: Specify the field used to specify how to sort query results.
            Default to bill date.
          enum:
          - USAGE_DATES
          - BILL_DATES
          - TOTAL_PRICE_CENTS
          type: string
        sortOrder:
          description: Specify the sort order (ascending / descending) used to specify
            how to sort query results. Defaults to descending.
          enum:
          - ASCENDING
          - DESCENDING
          type: string
      type: object
    ApiSearchDeploymentRequestView:
      properties:
        specs:
          description: |-
            List of settings that configure the Search Nodes for your cluster.

            **NOTE**: We accept a single configuration for all nodes currently.
          items:
            "$ref": "#/components/schemas/ApiSearchDeploymentSpecView"
          maxItems: 1
          minItems: 1
          type: array
      required:
      - specs
      type: object
    ApiSearchDeploymentResponseView:
      properties:
        encryptionAtRestProvider:
          description: Cloud service provider that manages your customer keys to provide
            an additional layer of Encryption At Rest for the cluster.
          enum:
          - NONE
          - AWS
          - AZURE
          - GCP
          externalDocs:
            description: Encryption at Rest using Customer Key Management
            url: https://www.mongodb.com/docs/atlas/security-kms-encryption/
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the search
            deployment.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        specs:
          description: List of settings that configure the Search Nodes for your cluster.
            The configuration will be returned for each region and shard.
          items:
            "$ref": "#/components/schemas/ApiSearchDeploymentSpecView"
          readOnly: true
          type: array
        stateName:
          description: Human-readable label that indicates the current operating condition
            of this search deployment.
          enum:
          - IDLE
          - PAUSED
          - UPDATING
          readOnly: true
          type: string
      type: object
    ApiSearchDeploymentSpecView:
      properties:
        instanceSize:
          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
          - S40_STORAGE_NVME
          - S50_STORAGE_NVME
          - S60_STORAGE_NVME
          - S80_STORAGE_NVME
          - S90_STORAGE_NVME
          type: string
        nodeCount:
          description: Number of Search Nodes in the cluster.
          example: 2
          format: int32
          maximum: 32
          minimum: 2
          type: integer
      required:
      - instanceSize
      - nodeCount
      type: object
    ApiStreamsAWSRegionView:
      description: Atlas Streams AWS Regions.
      enum:
      - SYDNEY_AUS
      - MUMBAI_IND
      - FRANKFURT_DEU
      - DUBLIN_IRL
      - LONDON_GBR
      - VIRGINIA_USA
      - OHIO_USA
      - OREGON_USA
      - SAOPAULO_BRA
      - MONTREAL_CAN
      - TOKYO_JPN
      - SINGAPORE_SGP
      type: string
    ApiStreamsAzureRegionView:
      description: Atlas Streams Azure Regions.
      enum:
      - eastus
      - westus
      - eastus2
      - westeurope
      type: string
    ApiStreamsGCPRegionView:
      description: Atlas Streams GCP Regions.
      enum:
      - US_CENTRAL1
      - EUROPE_WEST1
      - US_EAST4
      type: string
    ApiUserEventTypeViewForNdsGroup:
      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
      type: string
    ApiUserEventTypeViewForOrg:
      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
      type: string
    ApiUserEventViewForNdsGroup:
      description: API User event identifies different activities around user API
        keys.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ApiUserEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        targetPublicKey:
          description: Public part of the API key that this event targets.
          example: zmmrboas
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
        whitelistEntry:
          description: Entry in the list of source host addresses that the API key
            accepts and this event targets.
          example: 0.0.0.0
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: API User Events
      type: object
    ApiUserEventViewForOrg:
      description: API User event identifies different activities around user API
        keys.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ApiUserEventTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        targetPublicKey:
          description: Public part of the API key that this event targets.
          example: zmmrboas
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
        whitelistEntry:
          description: Entry in the list of source host addresses that the API key
            accepts and this event targets.
          example: 0.0.0.0
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: API User Events
      type: object
    AppServiceAlertConfigViewForNdsGroup:
      description: App Services metric alert configuration allows to select which
        app service conditions and events trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: App Services Alert Configuration
      type: object
    AppServiceAlertView:
      description: App Services alert notifies different activities about a BAAS application.
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/AppServiceEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: App Services Alerts
      type: object
    AppServiceEventTypeView:
      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
      type: string
    AppServiceEventTypeViewAlertable:
      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
      type: string
    AppServiceEventTypeViewAlertableNoThreshold:
      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
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: App Services Event Types
      type: string
    AppServiceEventTypeViewAlertableWithThreshold:
      description: Event type that triggers an alert.
      enum:
      - OUTSIDE_REALM_METRIC_THRESHOLD
      example: OUTSIDE_REALM_METRIC_THRESHOLD
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: App Services Event Types
      type: string
    AppServiceEventView:
      description: App Services event identifies different activities about a BAAS
        application.
      properties:
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/AppServiceEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
      required:
      - created
      - eventTypeName
      - id
      title: App Services Events
      type: object
    AppServiceMetricAlertConfigViewForNdsGroup:
      description: App Services metric alert configuration allows to select which
        app service metrics trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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"
          type: array
        metricThreshold:
          "$ref": "#/components/schemas/AppServiceMetricThreshold"
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: App Services Metric Alert Configuration
      type: object
    AppServiceMetricMatcher:
      description: Rules to apply when comparing an app service metric against this
        alert configuration.
      properties:
        fieldName:
          "$ref": "#/components/schemas/AppServiceMetricMatcherField"
        operator:
          description: Comparison operator to apply when checking the current metric
            value against **matcher[n].value**. The `REGEX` operator only supports
            inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
          type: string
        value:
          description: Value to match or exceed using the specified `matchers.operator`.
          example: event-replica-set
          type: string
      required:
      - fieldName
      - operator
      - value
      title: Matchers
      type: object
    AppServiceMetricMatcherField:
      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
      type: string
    AppServiceMetricThreshold:
      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_READS_FAILED: "#/components/schemas/DataMetricThresholdView"
          REALM_SYNC_CLIENT_UPLOADS_FAILED: "#/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
      oneOf:
      - "$ref": "#/components/schemas/RawMetricThresholdView"
      - "$ref": "#/components/schemas/DataMetricThresholdView"
      - "$ref": "#/components/schemas/TimeMetricThresholdView"
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      required:
      - metricName
      title: App Services Metric Threshold
      type: object
    AssertMsgRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    AssertRegularRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    AssertUserRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    AssertWarningRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    AtlasClusterOutageSimulationOutageFilter:
      properties:
        cloudProvider:
          description: The cloud provider of the region that undergoes the outage
            simulation.
          enum:
          - AWS
          - GCP
          - AZURE
          type: string
        regionName:
          description: The name of the region to undergo an outage simulation.
          type: string
        type:
          description: The type of cluster outage to simulate. `REGION` simulates
            a cluster outage for a region.
          enum:
          - REGION
          type: string
      type: object
    AtlasDataFederationAzureRegion:
      description: Atlas Data Federation Azure Regions.
      enum:
      - VIRGINIA_USA
      - AMSTERDAM_NLD
      - SAOPAULO_BRA
      type: string
    AtlasDataFederationGCPRegion:
      description: Atlas Data Federation GCP Regions.
      enum:
      - IOWA_USA
      - BELGIUM_EU
      type: string
    AtlasOrganization:
      description: Details that describe the organization.
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the organization.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isDeleted:
          description: Flag that indicates whether this organization has been deleted.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the organization.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
        skipDefaultAlertsSettings:
          default: false
          description: Disables automatic alert creation. When set to true, no organization
            level alerts will be created automatically.
          type: boolean
      required:
      - name
      type: object
    AtlasResourcePolicyAuditForNdsGroup:
      description: Atlas resource policy audits indicate organization level changes
        to resource policies.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          description: Unique identifier of event type.
          enum:
          - RESOURCE_POLICY_VIOLATED
          example: RESOURCE_POLICY_VIOLATED
          title: Atlas Resource Policy Audit Types
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        resourcePolicyId:
          description: Unique 24-hexadecimal character string that identifies the
            resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
        violatedPolicies:
          description: String representation of the violated resource policy ids.
          items:
            type: string
          type: array
        violationAction:
          description: Resource policy action taken by the user and evaluated against
            the currently active policies.
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Atlas Resource Policy Audits For Atlas Group
      type: object
    AtlasResourcePolicyAuditForOrg:
      description: Atlas resource policy audits indicate organization level changes
        to resource policies.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          description: Unique identifier of event type.
          enum:
          - RESOURCE_POLICY_CREATED
          - RESOURCE_POLICY_MODIFIED
          - RESOURCE_POLICY_DELETED
          - RESOURCE_POLICY_VIOLATED
          example: RESOURCE_POLICY_CREATED
          title: Atlas Resource Policy Audit Types
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        resourcePolicyId:
          description: Unique 24-hexadecimal character string that identifies the
            resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Atlas Resource Policy Audits
      type: object
    AtlasSearchAnalyzer:
      properties:
        charFilters:
          description: Filters that examine text one character at a time and perform
            filtering operations.
          items:
            "$ref": "#/components/schemas/BasicDBObject"
          type: array
        name:
          description: |-
            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.`
          type: string
        tokenFilters:
          description: |-
            Filter that performs operations such as:

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

            - Redaction, which is the removal of sensitive information from public documents.
          items:
            "$ref": "#/components/schemas/BasicDBObject"
          type: array
        tokenizer:
          additionalProperties:
            description: Tokenizer that you want to use to create tokens. Tokens determine
              how Atlas Search splits up text into discrete chunks for indexing.
            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.
          type: object
      required:
      - name
      - tokenizer
      title: Atlas Search Analyzer
      type: object
    AtlasTenantClusterUpgradeRequest20240805:
      description: Request containing target state of tenant cluster to be upgraded.
      properties:
        acceptDataRisksAndForceReplicaSetReconfig:
          description: If reconfiguration is necessary to regain a primary due to
            a regional outage, submit this field alongside your topology reconfiguration
            to request a new regional outage resistant topology. Forced reconfigurations
            during an outage of the majority of electable nodes carry a risk of data
            loss if replicated writes (even majority committed writes) have not been
            replicated to the new primary node. MongoDB Atlas docs contain more information.
            To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig`
            to the current date. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          externalDocs:
            description: Reconfiguring a Replica Set during a regional outage
            url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set
          format: date-time
          type: string
        advancedConfiguration:
          "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView"
        backupEnabled:
          default: false
          description: Flag that indicates whether the cluster can perform backups.
            If set to `true`, the cluster can perform backups. You must set this value
            to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters
            and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/)
            for tenant clusters. If set to `false`, the cluster doesn't use backups.
          externalDocs:
            description: Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        biConnector:
          "$ref": "#/components/schemas/BiConnector"
        clusterType:
          description: Configuration of nodes that comprise the cluster.
          enum:
          - REPLICASET
          - SHARDED
          - GEOSHARDED
          type: string
        configServerManagementMode:
          default: ATLAS_MANAGED
          description: Config Server Management Mode for creating or updating a sharded
            cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch
            the cluster's config server type for optimal performance and savings.
            When configured as `FIXED_TO_DEDICATED`, the cluster will always use a
            dedicated config server.
          enum:
          - ATLAS_MANAGED
          - FIXED_TO_DEDICATED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          type: string
        configServerType:
          description: Describes a sharded cluster's config server type.
          enum:
          - DEDICATED
          - EMBEDDED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          readOnly: true
          type: string
        connectionStrings:
          "$ref": "#/components/schemas/ClusterConnectionStrings"
        createDate:
          description: Date and time when MongoDB Cloud created this cluster. This
            parameter expresses its value in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        diskWarmingMode:
          default: FULLY_WARMED
          description: Disk warming mode selection.
          enum:
          - FULLY_WARMED
          - VISIBLE_EARLIER
          externalDocs:
            description: Reduce Secondary Disk Warming Impact
            url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact
          type: string
        effectiveReplicationSpecs:
          description: List of settings that represent the actual cluster state. This
            is read-only and always returned in the response. It reflects the current
            cluster configuration, which may differ from `replicationSpecs` due to
            system-managed changes.
          items:
            "$ref": "#/components/schemas/ReplicationSpec20240805"
          readOnly: true
          type: array
        encryptionAtRestProvider:
          description: 'Cloud service provider that manages your customer keys to
            provide an additional layer of encryption at rest for the cluster. To
            enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize`
            setting must be `M10` or higher and `"backupEnabled" : false` or omitted
            entirely.'
          enum:
          - NONE
          - AWS
          - AZURE
          - GCP
          externalDocs:
            description: Encryption at Rest using Customer Key Management
            url: https://www.mongodb.com/docs/atlas/security-kms-encryption/
          type: string
        featureCompatibilityVersion:
          description: Feature compatibility version of the cluster. This will always
            appear regardless of whether FCV is pinned.
          readOnly: true
          type: string
        featureCompatibilityVersionExpirationDate:
          description: Feature compatibility version expiration date. Will only appear
            if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          format: date-time
          readOnly: true
          type: string
        globalClusterSelfManagedSharding:
          description: |-
            Set this field to configure the Sharding Management Mode when creating a new Global Cluster.

            When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.

            When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.

            This setting cannot be changed once the cluster is deployed.
          externalDocs:
            description: Creating a Global Cluster
            url: https://dochub.mongodb.org/core/global-cluster-management
          type: boolean
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        internalClusterRole:
          description: 'Internal classification of the cluster''s role. Possible values:
            `NONE` (regular user cluster), `SYSTEM_CLUSTER` (system cluster for backup),
            `INTERNAL_SHADOW_CLUSTER` (internal use shadow cluster for testing).'
          enum:
          - NONE
          - SYSTEM_CLUSTER
          - INTERNAL_SHADOW_CLUSTER
          readOnly: true
          type: string
        labels:
          deprecated: true
          description: |-
            Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

            Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ComponentLabel"
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBEmployeeAccessGrant:
          "$ref": "#/components/schemas/EmployeeAccessGrantView"
        mongoDBMajorVersion:
          description: "MongoDB major version of the cluster. Set to the binary major
            version. \n\nOn creation: Choose from the available versions of MongoDB,
            or leave unspecified for the current recommended default in the MongoDB
            Cloud platform. The recommended version is a recent Long Term Support
            version. The default is not guaranteed to be the most recently released
            version throughout the entire release cycle. For versions available in
            a specific project, see the linked documentation or use the API endpoint
            for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).\n\n
            On update: Increase version only by 1 major version at a time. If the
            cluster is pinned to a MongoDB feature compatibility version exactly one
            major version below the current MongoDB version, the MongoDB version can
            be downgraded to the previous major version."
          externalDocs:
            description: Available MongoDB Versions in Atlas
            url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-
          type: string
        mongoDBVersion:
          description: Version of MongoDB that the cluster runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the cluster.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        paused:
          description: Flag that indicates whether the cluster is paused.
          type: boolean
        pitEnabled:
          description: Flag that indicates whether the cluster uses continuous cloud
            backups.
          externalDocs:
            description: Continuous Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        redactClientLogData:
          description: |-
            Enable or disable log redaction.

            This setting configures the ``mongod`` or ``mongos`` to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.

            Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.

            *Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
          externalDocs:
            description: Log Redaction
            url: https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction
          type: boolean
        replicaSetScalingStrategy:
          default: WORKLOAD_TYPE
          description: |-
            Set this field to configure the replica set scaling mode for your cluster.

            By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.

            When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.

            When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
          enum:
          - SEQUENTIAL
          - WORKLOAD_TYPE
          - NODE_TYPE
          externalDocs:
            description: Modify the Replica Set Scaling Mode
            url: https://dochub.mongodb.org/core/scale-nodes
          type: string
        replicationSpecs:
          description: List of settings that configure your cluster regions. This
            array has one object per shard representing node configurations in each
            shard. For replica sets there is only one object representing node configurations.
          items:
            "$ref": "#/components/schemas/ReplicationSpec20240805"
          type: array
        retainBackups:
          default: false
          description: Flag that indicates whether the cluster retains backups.
          type: boolean
        rootCertType:
          default: ISRGROOTX1
          description: Root Certificate Authority that MongoDB Atlas cluster uses.
            MongoDB Cloud supports Internet Security Research Group.
          enum:
          - ISRGROOTX1
          type: string
        stateName:
          description: |-
            Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

             - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
             - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
             - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
             - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
             - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the cluster.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
        useAwsTimeBasedSnapshotCopyForFastInitialSync:
          default: false
          description: Flag that indicates whether AWS time-based snapshot copies
            will be used instead of slower standard snapshot copies during fast Atlas
            cross-region initial syncs. This flag is only relevant for clusters containing
            AWS nodes.
          type: boolean
        versionReleaseSystem:
          default: LTS
          description: Method by which the cluster maintains the MongoDB versions.
            If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`.
          enum:
          - LTS
          - CONTINUOUS
          type: string
      required:
      - name
      title: Tenant Cluster Upgrade Request
      type: object
    AuditLog:
      properties:
        auditAuthorizationSuccess:
          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
          type: boolean
        auditFilter:
          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/
          type: string
        configurationType:
          description: Human-readable label that displays how to configure the audit
            filter.
          enum:
          - NONE
          - FILTER_BUILDER
          - FILTER_JSON
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled database auditing
            for the specified project.
          type: boolean
      type: object
    AuthFederationRoleMapping:
      description: Mapping settings that link one IdP and MongoDB Cloud.
      properties:
        externalGroupName:
          description: Unique human-readable label that identifies the identity provider
            group to which this role mapping applies.
          maxLength: 200
          minLength: 1
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this role
            mapping.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        roleAssignments:
          description: Atlas roles and the unique identifiers of the groups and organizations
            associated with each role. The array must include at least one element
            with an Organization role and its respective `orgId`. Each element in
            the array can have a value for `orgId` or `groupId`, but not both.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfigRoleAssignment"
          type: array
          uniqueItems: true
      required:
      - externalGroupName
      - roleAssignments
      title: Federated Authentication Role Mapping
      type: object
    AutoExportPolicyView:
      description: Policy for automatically exporting Cloud Backup Snapshots.
      properties:
        exportBucketId:
          description: Unique 24-hexadecimal character string that identifies the
            Export Bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        frequencyType:
          description: Human-readable label that indicates the rate at which the export
            policy item occurs.
          enum:
          - monthly
          - yearly
          type: string
      title: export
      type: object
    AutomationConfigEventTypeView:
      description: Unique identifier of event type.
      enum:
      - AUTOMATION_CONFIG_PUBLISHED_AUDIT
      example: AUTOMATION_CONFIG_PUBLISHED_AUDIT
      title: Automation Config Event Types
      type: string
    AutomationConfigEventView:
      description: Automation configuration event identifies that deployment configuration
        is published.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/AutomationConfigEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Automation Config Events
      type: object
    AvailableCloudProviderRegion:
      properties:
        default:
          description: Flag that indicates whether the cloud provider sets this region
            as its default. AWS defaults to `US_EAST_1`, GCP defaults to `CENTRAL_US`,
            and AZURE defaults to `US_WEST_2`.
          readOnly: true
          type: boolean
        name:
          description: Human-readable label that identifies the supported region.
          readOnly: true
          type: string
      type: object
    AvailableClustersDeployment:
      description: Deployments that can be migrated to MongoDB Atlas.
      properties:
        agentVersion:
          description: Version of MongoDB Agent that monitors/manages the cluster.
          readOnly: true
          type: string
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        dbSizeBytes:
          description: Size of this database on disk at the time of the request expressed
            in bytes.
          example: 8192
          format: int64
          readOnly: true
          type: integer
        featureCompatibilityVersion:
          description: Version of MongoDB features that this cluster supports.
          externalDocs:
            description: MongoDB feature versions
            url: https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion
          readOnly: true
          type: string
        managed:
          description: Flag that indicates whether Automation manages this cluster.
          readOnly: true
          type: boolean
        mongoDBVersion:
          description: Version of MongoDB that this cluster runs.
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies this cluster.
          example: Project X sharded cluster
          readOnly: true
          type: string
        oplogSizeMB:
          description: Size of the Oplog on disk at the time of the request expressed
            in MB.
          example: 3
          format: int32
          readOnly: true
          type: integer
        sharded:
          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
          type: boolean
        shardsSize:
          description: Number of shards that comprise this cluster.
          example: 3
          format: int32
          readOnly: true
          type: integer
        tlsEnabled:
          description: Flag that indicates whether someone enabled TLS for this cluster.
          readOnly: true
          type: boolean
      required:
      - featureCompatibilityVersion
      - managed
      - mongoDBVersion
      - name
      - sharded
      - tlsEnabled
      title: Available Clusters
      type: object
    AvgCommandExecutionTimeTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    AvgReadExecutionTimeTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    AvgWriteExecutionTimeTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    AwsNetworkPeeringConnectionSettings:
      description: Group of Network Peering connection settings.
      properties:
        accepterRegionName:
          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.
          type: string
        awsAccountId:
          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.
          pattern: "^[0-9]{12}$"
          type: string
        connectionId:
          description: Unique string that identifies the peering connection on AWS.
          readOnly: true
          type: string
        containerId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        errorStateName:
          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
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        providerName:
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        routeTableCidrBlock:
          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}$"
          type: string
        statusName:
          description: State of the network peering connection at the time you made
            the request.
          enum:
          - INITIATING
          - PENDING_ACCEPTANCE
          - FAILED
          - FINALIZING
          - AVAILABLE
          - TERMINATING
          readOnly: true
          type: string
        vpcId:
          description: Unique string that identifies the VPC on Amazon Web Services
            (AWS) that you want to peer with the MongoDB Cloud VPC.
          pattern: "^vpc-[0-9a-f]{17}$"
          type: string
      required:
      - accepterRegionName
      - awsAccountId
      - containerId
      - routeTableCidrBlock
      - vpcId
      title: AWS
      type: object
    AzureAccountDetails:
      properties:
        azureSubscriptionId:
          description: The Azure Subscription ID.
          type: string
        cidrBlock:
          description: The VPC CIDR Block.
          type: string
        cloudProvider:
          description: Cloud provider.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        virtualNetworkName:
          description: The name of the virtual network.
          type: string
      type: object
    AzureCloudProviderContainer:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderContainer"
      - properties:
          atlasCidrBlock:
            description: |-
              IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

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

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

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

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

               **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.
            pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
            type: string
          azureSubscriptionId:
            description: Unique string that identifies the Azure subscription in which
              the MongoDB Cloud VNet resides.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          region:
            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_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
            - SPAIN_CENTRAL
            - MEXICO_CENTRAL
            - NEW_ZEALAND_NORTH
            - INDONESIA_CENTRAL
            - MALAYSIA_WEST
            - CHILE_CENTRAL
            - US_GOV_VIRGINIA
            - US_GOV_ARIZONA
            - US_GOV_TEXAS
            type: string
          vnetName:
            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.
            pattern: "^([-\\w._()])$"
            readOnly: true
            type: string
        type: object
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      required:
      - atlasCidrBlock
      - region
      title: AZURE
      type: object
    AzureCloudProviderSettings:
      allOf:
      - "$ref": "#/components/schemas/ClusterProviderSettings"
      - properties:
          autoScaling:
            "$ref": "#/components/schemas/CloudProviderAzureAutoScaling"
          diskTypeName:
            description: Disk type that corresponds to the host's root volume for
              Azure instances. If omitted, the default disk type for the selected
              `providerSettings.instanceSizeName` applies.
            enum:
            - P2
            - P3
            - P4
            - P6
            - P10
            - P15
            - P20
            - P30
            - P40
            - P50
            externalDocs:
              description: Disk type
              url: https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes
            type: string
          instanceSizeName:
            description: Cluster tier, with a default storage and memory capacity,
              that applies to all the data-bearing hosts in your cluster.
            enum:
            - M10
            - M20
            - M30
            - M40
            - M50
            - M60
            - M80
            - M90
            - M200
            - R40
            - R50
            - R60
            - R80
            - R200
            - R300
            - R400
            - M60_NVME
            - M80_NVME
            - M200_NVME
            - M300_NVME
            - M400_NVME
            - M600_NVME
            title: Azure Instance Sizes
            type: string
          regionName:
            description: Microsoft Azure Regions.
            enum:
            - US_CENTRAL
            - US_EAST
            - US_EAST_2
            - US_NORTH_CENTRAL
            - US_WEST
            - US_SOUTH_CENTRAL
            - EUROPE_NORTH
            - EUROPE_WEST
            - US_WEST_CENTRAL
            - US_WEST_2
            - US_WEST_3
            - CANADA_EAST
            - CANADA_CENTRAL
            - BRAZIL_SOUTH
            - BRAZIL_SOUTHEAST
            - AUSTRALIA_CENTRAL
            - AUSTRALIA_CENTRAL_2
            - AUSTRALIA_EAST
            - AUSTRALIA_SOUTH_EAST
            - GERMANY_WEST_CENTRAL
            - GERMANY_NORTH
            - SWEDEN_CENTRAL
            - SWEDEN_SOUTH
            - SWITZERLAND_NORTH
            - SWITZERLAND_WEST
            - UK_SOUTH
            - UK_WEST
            - NORWAY_EAST
            - NORWAY_WEST
            - INDIA_CENTRAL
            - INDIA_SOUTH
            - INDIA_WEST
            - CHINA_EAST
            - CHINA_NORTH
            - ASIA_EAST
            - JAPAN_EAST
            - JAPAN_WEST
            - ASIA_SOUTH_EAST
            - KOREA_CENTRAL
            - KOREA_SOUTH
            - FRANCE_CENTRAL
            - FRANCE_SOUTH
            - SOUTH_AFRICA_NORTH
            - SOUTH_AFRICA_WEST
            - UAE_CENTRAL
            - UAE_NORTH
            - QATAR_CENTRAL
            - POLAND_CENTRAL
            - ISRAEL_CENTRAL
            - ITALY_NORTH
            - SPAIN_CENTRAL
            - MEXICO_CENTRAL
            - NEW_ZEALAND_NORTH
            - US_GOV_VIRGINIA
            - US_GOV_ARIZONA
            - US_GOV_TEXAS
            externalDocs:
              description: Azure
              url: https://docs.atlas.mongodb.com/reference/microsoft-azure/
            title: Azure Regions
            type: string
        type: object
      type: object
    AzureComputeAutoScalingRules:
      description: Collection of settings that configures how a cluster might scale
        its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling
        is unavailable for clusters using Low CPU or NVME storage classes.
      properties:
        maxInstanceSize:
          description: Maximum instance size to which your cluster can automatically
            scale.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M90
          - M200
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - M60_NVME
          - M80_NVME
          - M200_NVME
          - M300_NVME
          - M400_NVME
          - M600_NVME
          title: Azure Instance Sizes
          type: string
        minInstanceSize:
          description: Minimum instance size to which your cluster can automatically
            scale.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M90
          - M200
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - M60_NVME
          - M80_NVME
          - M200_NVME
          - M300_NVME
          - M400_NVME
          - M600_NVME
          title: Azure Instance Sizes
          type: string
      title: Azure
      type: object
    AzureConnection:
      description: Azure-specific configuration for the connection.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        region:
          description: Azure region where the storage account is located.
          type: string
        servicePrincipalId:
          description: Unique ID of the Azure Service Principal that has access to
            the storage account.
          type: string
        storageAccountName:
          description: Name of the Azure Storage Account to connect to.
          type: string
      type: object
    AzureCreateDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/CreateDataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you wish to store your archived data.
            enum:
            - US_EAST_2
            - EUROPE_WEST
            - BRAZIL_SOUTH
            type: string
        type: object
      type: object
    AzureDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/DataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you store your archived data.
            enum:
            - US_EAST_2
            - EUROPE_WEST
            - BRAZIL_SOUTH
            readOnly: true
            type: string
        type: object
      type: object
    AzureHardwareSpec20240805:
      properties:
        diskIOPS:
          description: |-
            Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:

            - set `replicationSpecs[n].regionConfigs[m].providerName` : `Azure`.
            - set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` : `M40` or greater not including `Mxx_NVME` tiers.

            The maximum input/output operations per second (IOPS) depend on the selected `.instanceSize` and `.diskSizeGB`.
            This parameter defaults to the cluster tier's standard IOPS value.
            Changing this value impacts cluster cost.
          externalDocs:
            description: Programmatic API Keys
            url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure
          format: int32
          type: integer
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value must be equal for
            all shards and node types.\n\n This value is not configurable on M0/M2/M5
            clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n
            If you specify a disk size below the minimum (10 GB), this parameter defaults
            to the minimum disk size value. \n\n Storage charge calculations depend
            on whether you choose the default value or a custom value.\n\n The maximum
            value for disk storage cannot exceed 50 times the maximum RAM for the
            selected cluster. If you require more storage space, consider upgrading
            your cluster to a higher tier."
          externalDocs:
            description: Customize Storage
            url: https://dochub.mongodb.org/core/customize-storage
          format: double
          type: number
        instanceSize:
          description: Hardware specification for the instance sizes in this region
            in this shard. Each instance size has a default storage and memory capacity.
            Electable nodes and read-only nodes (known as "base nodes") within a single
            shard must use the same instance size. Analytics nodes can scale independently
            from base nodes within a shard. Both base nodes and analytics nodes can
            scale independently from their equivalents in other shards.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M90
          - M200
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - M60_NVME
          - M80_NVME
          - M200_NVME
          - M300_NVME
          - M400_NVME
          - M600_NVME
          title: Azure Instance Sizes
          type: string
        nodeCount:
          description: Number of nodes of the given type for MongoDB Cloud to deploy
            to the region.
          format: int32
          type: integer
      type: object
    AzureKeyVault:
      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:
          description: Azure environment in which your account credentials reside.
          enum:
          - AZURE
          - AZURE_CHINA
          - AZURE_US_GOVERNMENT
          type: string
        clientID:
          description: Unique 36-hexadecimal character string that identifies an Azure
            application associated with your Azure Active Directory tenant.
          format: uuid
          type: string
        enabled:
          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`.
          type: boolean
        keyIdentifier:
          description: Web address with a unique key that identifies for your Azure
            Key Vault.
          example: https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86
          type: string
        keyVaultName:
          description: Unique string that identifies the Azure Key Vault that contains
            your key. This field cannot be modified when you enable and set up private
            endpoint connections to your Azure Key Vault.
          type: string
        requirePrivateNetworking:
          description: Enable connection to your Azure Key Vault over private networking.
          type: boolean
        resourceGroupName:
          description: Name of the Azure resource group that contains your Azure Key
            Vault. This field cannot be modified when you enable and set up private
            endpoint connections to your Azure Key Vault.
          type: string
        roleId:
          description: Unique 24-hexadecimal digit string that identifies the Azure
            Service Principal that MongoDB Cloud uses to access the Azure Key Vault.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        secret:
          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
          type: string
          writeOnly: true
        subscriptionID:
          description: Unique 36-hexadecimal character string that identifies your
            Azure subscription. This field cannot be modified when you enable and
            set up private endpoint connections to your Azure Key Vault.
          format: uuid
          type: string
        tenantID:
          description: Unique 36-hexadecimal character string that identifies the
            Azure Active Directory tenant within your Azure subscription.
          format: uuid
          type: string
        valid:
          description: Flag that indicates whether the Azure encryption key can encrypt
            and decrypt data.
          readOnly: true
          type: boolean
      type: object
    AzureKeyVaultEARPrivateEndpoint:
      description: Azure Key Vault Encryption At Rest Private Endpoint.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider for
            the Encryption At Rest private endpoint.
          enum:
          - AZURE
          - AWS
          readOnly: true
          type: string
        errorMessage:
          description: Error message for failures associated with the Encryption At
            Rest private endpoint.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        privateEndpointConnectionName:
          description: Connection name of the Azure Private Endpoint.
          readOnly: true
          type: string
        regionName:
          description: Cloud provider region in which the Encryption At Rest private
            endpoint is located.
          oneOf:
          - description: Microsoft Azure Regions.
            enum:
            - US_CENTRAL
            - US_EAST
            - US_EAST_2
            - US_NORTH_CENTRAL
            - US_WEST
            - US_SOUTH_CENTRAL
            - EUROPE_NORTH
            - EUROPE_WEST
            - US_WEST_CENTRAL
            - US_WEST_2
            - US_WEST_3
            - CANADA_EAST
            - CANADA_CENTRAL
            - BRAZIL_SOUTH
            - BRAZIL_SOUTHEAST
            - AUSTRALIA_CENTRAL
            - AUSTRALIA_CENTRAL_2
            - AUSTRALIA_EAST
            - AUSTRALIA_SOUTH_EAST
            - GERMANY_WEST_CENTRAL
            - GERMANY_NORTH
            - SWEDEN_CENTRAL
            - SWEDEN_SOUTH
            - SWITZERLAND_NORTH
            - SWITZERLAND_WEST
            - UK_SOUTH
            - UK_WEST
            - NORWAY_EAST
            - NORWAY_WEST
            - INDIA_CENTRAL
            - INDIA_SOUTH
            - INDIA_WEST
            - CHINA_EAST
            - CHINA_NORTH
            - ASIA_EAST
            - JAPAN_EAST
            - JAPAN_WEST
            - ASIA_SOUTH_EAST
            - KOREA_CENTRAL
            - KOREA_SOUTH
            - FRANCE_CENTRAL
            - FRANCE_SOUTH
            - SOUTH_AFRICA_NORTH
            - SOUTH_AFRICA_WEST
            - UAE_CENTRAL
            - UAE_NORTH
            - QATAR_CENTRAL
            - POLAND_CENTRAL
            - ISRAEL_CENTRAL
            - ITALY_NORTH
            - SPAIN_CENTRAL
            - MEXICO_CENTRAL
            - NEW_ZEALAND_NORTH
            - US_GOV_VIRGINIA
            - US_GOV_ARIZONA
            - US_GOV_TEXAS
            title: Azure Regions
            type: string
          - description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_EAST_2
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_SOUTH_1
            - AP_SOUTH_2
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - ME_CENTRAL_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            title: AWS Regions
            type: string
          type: object
        status:
          description: State of the Encryption At Rest private endpoint.
          enum:
          - INITIATING
          - PENDING_ACCEPTANCE
          - ACTIVE
          - FAILED
          - PENDING_RECREATION
          - DELETING
          readOnly: true
          type: string
      title: Azure Key Vault EAR Private Endpoint
      type: object
    AzureLogIntegrationRequest:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationRequest"
      - properties:
          prefixPath:
            description: Path prefix where the log files will be stored. Atlas will
              add further sub-directories based on the log type.
            example: logs/mongodb/
            type: string
          roleId:
            description: Unique 24-character hexadecimal string that identifies the
              Atlas Cloud Provider Access role.
            example: 507f1f77bcf86cd799439011
            pattern: "^[a-fA-F0-9]{24}$"
            type: string
          storageAccountName:
            description: Storage account name where logs will be stored.
            example: mylogstorageaccount
            type: string
          storageContainerName:
            description: Storage container name for log files.
            example: mongodb-logs
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - AZURE_LOG_EXPORT
            type: string
        type: object
      description: Request schema for creating or updating an Azure Blob Storage log
        export integration.
      required:
      - logTypes
      - prefixPath
      - roleId
      - storageAccountName
      - storageContainerName
      - type
      title: Azure Log Export Integration Request
      type: object
    AzureLogIntegrationResponse:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationResponse"
      - properties:
          prefixPath:
            description: Path prefix where the log files will be stored. Atlas will
              add further sub-directories based on the log type.
            example: logs/mongodb/
            type: string
          roleId:
            description: Unique 24-character hexadecimal string that identifies the
              Atlas Cloud Provider Access role.
            example: 507f1f77bcf86cd799439011
            pattern: "^[a-fA-F0-9]{24}$"
            type: string
          storageAccountName:
            description: Storage account name where logs will be stored.
            example: mylogstorageaccount
            type: string
          storageContainerName:
            description: Storage container name for log files.
            example: mongodb-logs
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - AZURE_LOG_EXPORT
            type: string
        type: object
      description: Details to integrate Azure Blob Storage log export with one Atlas
        project.
      required:
      - id
      - logTypes
      - prefixPath
      - roleId
      - storageAccountName
      - storageContainerName
      - type
      title: Azure Log Export Integration Response
      type: object
    AzureNetworkPeeringConnectionSettings:
      description: Group of Network Peering connection settings.
      properties:
        azureDirectoryId:
          description: Unique string that identifies the Azure AD directory in which
            the VNet peered with the MongoDB Cloud VNet resides.
          format: uuid
          type: string
        azureSubscriptionId:
          description: Unique string that identifies the Azure subscription in which
            the VNet you peered with the MongoDB Cloud VNet resides.
          format: uuid
          type: string
        containerId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        errorState:
          description: 'Error message returned when a requested Azure network peering
            resource returns `"status" : "FAILED"`. The resource returns `null` if
            the request succeeded.'
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        providerName:
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        resourceGroupName:
          description: Human-readable label that identifies the resource group in
            which the VNet to peer with the MongoDB Cloud VNet resides.
          pattern: "^([-\\w._()])+$"
          type: string
        status:
          description: State of the network peering connection at the time you made
            the request.
          enum:
          - ADDING_PEER
          - AVAILABLE
          - FAILED
          - DELETION_FAILED
          - DELETING
          readOnly: true
          type: string
        vnetName:
          description: Human-readable label that identifies the VNet that you want
            to peer with the MongoDB Cloud VNet.
          pattern: "^([-\\w._()])$"
          type: string
      required:
      - azureDirectoryId
      - azureSubscriptionId
      - containerId
      - resourceGroupName
      - vnetName
      title: AZURE
      type: object
    AzurePrivateEndpoint:
      description: Group of Private Endpoint settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        deleteRequested:
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
          type: boolean
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        privateEndpointConnectionName:
          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
          type: string
        privateEndpointIPAddress:
          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}$"
          type: string
        privateEndpointResourceId:
          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
          type: string
        status:
          description: State of the Azure Private Link Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
          type: string
      required:
      - cloudProvider
      title: AZURE
      type: object
    AzurePrivateLinkConnection:
      description: Group of Private Endpoint Service settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        privateEndpoints:
          description: List of private endpoints assigned to this Azure Private Link
            Service.
          items:
            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
            type: string
          readOnly: true
          type: array
        privateLinkServiceName:
          description: Unique string that identifies the Azure Private Link Service
            that MongoDB Cloud manages.
          pattern: "^pls_[0-9a-f]{24}$"
          readOnly: true
          type: string
        privateLinkServiceResourceId:
          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
          type: string
        regionName:
          description: Cloud provider region that manages this Private Endpoint Service.
          readOnly: true
          type: string
        status:
          description: State of the Private Endpoint Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - WAITING_FOR_USER
          - FAILED
          - DELETING
          readOnly: true
          type: string
      required:
      - cloudProvider
      title: AZURE
      type: object
    AzureRegionConfig20240805:
      allOf:
      - "$ref": "#/components/schemas/CloudRegionConfig20240805"
      - properties:
          analyticsAutoScaling:
            "$ref": "#/components/schemas/AdvancedAutoScalingSettings"
          analyticsSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          autoScaling:
            "$ref": "#/components/schemas/AdvancedAutoScalingSettings"
          effectiveAnalyticsSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          effectiveElectableSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          effectiveReadOnlySpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          readOnlySpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
        type: object
      description: Details that explain how MongoDB Cloud replicates data in one region
        on the specified MongoDB database.
      title: Azure Regional Replication Specifications
      type: object
    BackupComplianceOnDemandPolicyItem:
      description: Specifications for on-demand policy.
      properties:
        frequencyInterval:
          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
          format: int32
          type: integer
        frequencyType:
          description: Human-readable label that identifies the frequency type associated
            with the backup policy.
          enum:
          - ondemand
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy item.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        retentionUnit:
          description: Unit of time in which MongoDB Cloud measures snapshot retention.
          enum:
          - days
          - weeks
          - months
          - years
          type: string
        retentionValue:
          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.
          format: int32
          type: integer
      required:
      - frequencyInterval
      - frequencyType
      - retentionUnit
      - retentionValue
      type: object
    BackupComplianceScheduledPolicyItem:
      description: Specifications for scheduled policy.
      properties:
        frequencyInterval:
          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
          format: int32
          type: integer
        frequencyType:
          description: Human-readable label that identifies the frequency type associated
            with the backup policy.
          enum:
          - daily
          - hourly
          - weekly
          - monthly
          - yearly
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy item.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        retentionUnit:
          description: Unit of time in which MongoDB Cloud measures Snapshot retention.
          enum:
          - days
          - weeks
          - months
          - years
          type: string
        retentionValue:
          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.
          format: int32
          type: integer
      required:
      - frequencyInterval
      - frequencyType
      - retentionUnit
      - retentionValue
      type: object
    BackupLabel:
      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:
          description: Key for the metadata file that MongoDB Cloud uploads to the
            bucket when the export job finishes.
          type: string
        value:
          description: Value for the key to include in file that MongoDB Cloud uploads
            to the bucket when the export job finishes.
          type: string
      type: object
    BackupOnlineArchive:
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the online
            archive.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster that contains
            the collection for which you want to create an online archive.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        collName:
          description: Human-readable label that identifies the collection for which
            you created the online archive.
          readOnly: true
          type: string
        collectionType:
          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
          type: string
        criteria:
          "$ref": "#/components/schemas/CriteriaView"
        dataExpirationRule:
          "$ref": "#/components/schemas/DataExpirationRuleView"
        dataProcessRegion:
          "$ref": "#/components/schemas/DataProcessRegionView"
        dataSetName:
          description: Human-readable label that identifies the dataset that Atlas
            generates for this online archive.
          readOnly: true
          type: string
        dbName:
          description: Human-readable label of the database that contains the collection
            that contains the online archive.
          readOnly: true
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        partitionFields:
          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
          type: array
        paused:
          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**.
          type: boolean
        schedule:
          "$ref": "#/components/schemas/OnlineArchiveSchedule"
        state:
          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
          type: string
      type: object
    BackupOnlineArchiveCreate:
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the online
            archive.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster that contains
            the collection for which you want to create an online archive.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        collName:
          description: Human-readable label that identifies the collection for which
            you created the online archive.
          type: string
          writeOnly: true
        collectionType:
          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
          type: string
          writeOnly: true
        criteria:
          "$ref": "#/components/schemas/CriteriaView"
        dataExpirationRule:
          "$ref": "#/components/schemas/DataExpirationRuleView"
        dataProcessRegion:
          "$ref": "#/components/schemas/CreateDataProcessRegionView"
        dataSetName:
          description: Human-readable label that identifies the dataset that Atlas
            generates for this online archive.
          readOnly: true
          type: string
        dbName:
          description: Human-readable label of the database that contains the collection
            that contains the online archive.
          maxLength: 64
          type: string
          writeOnly: true
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        partitionFields:
          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
          type: array
          writeOnly: true
        paused:
          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**.
          type: boolean
        schedule:
          "$ref": "#/components/schemas/OnlineArchiveSchedule"
        state:
          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
          type: string
      required:
      - collName
      - criteria
      - dbName
      type: object
    BackupRestoreJob:
      properties:
        batchId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        checkpointId:
          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
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
        clusterId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster containing
            the snapshots you want to retrieve.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when someone requested this restore job. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        delivery:
          "$ref": "#/components/schemas/BackupRestoreJobDelivery"
        deploymentJobId:
          description: Unique 24-hexadecimal digit string that identifies the an imported
            deployment job. This parameter exists when restoring from an imported
            snapshot/cluster shot.
          readOnly: true
          type: string
        encryptionEnabled:
          description: Flag that indicates whether someone encrypted the data in the
            restored snapshot.
          readOnly: true
          type: boolean
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns the snapshots.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hashes:
          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
          type: array
        id:
          description: Unique 24-hexadecimal digit string that identifies the restore
            job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        masterKeyUUID:
          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"`.'
          format: uuid
          readOnly: true
          type: string
        oplogInc:
          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.
          format: int32
          minimum: 1
          type: integer
          writeOnly: true
        oplogTs:
          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)$"
          type: string
          writeOnly: true
        pointInTimeUTCMillis:
          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. 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`.
          externalDocs:
            description: UNIX Epoch
            url: https://en.wikipedia.org/wiki/Unix_time
          format: int64
          minimum: 1199145600000
          type: integer
          writeOnly: true
        snapshotId:
          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
          pattern: "^([a-f0-9]{24})$"
          type: string
        statusName:
          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
          type: string
        timestamp:
          "$ref": "#/components/schemas/ApiBSONTimestampView"
      required:
      - delivery
      type: object
    BackupRestoreJobDelivery:
      description: Method and details that indicate how to deliver the restored snapshot
        data.
      properties:
        authHeader:
          description: 'Header name to use when downloading the restore, used with
            `"delivery.methodName" : "HTTP"`.'
          readOnly: true
          type: string
        authValue:
          description: 'Header value to use when downloading the restore, used with
            `"delivery.methodName" : "HTTP"`.'
          readOnly: true
          type: string
        expirationHours:
          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"`.'
          format: int32
          minimum: 1
          type: integer
        expires:
          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"`.'
          format: date-time
          readOnly: true
          type: string
        maxDownloads:
          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"`.'
          format: int32
          minimum: 1
          type: integer
        methodName:
          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
          type: string
        statusName:
          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
          - PENDING
          readOnly: true
          type: string
        targetClusterId:
          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
          pattern: "^([a-f0-9]{24})$"
          type: string
        targetClusterName:
          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.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        targetGroupId:
          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
          pattern: "^([a-f0-9]{24})$"
          type: string
        url:
          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
          type: string
        urlV2:
          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
          type: string
      required:
      - methodName
      title: Restore Snapshot Delivery Metadata
      type: object
    BackupSnapshot:
      properties:
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshots you want to return.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster.
          readOnly: true
          type: string
        complete:
          description: Flag that indicates whether the snapshot exists. This flag
            returns `false` while MongoDB Cloud creates the snapshot.
          readOnly: true
          type: boolean
        created:
          "$ref": "#/components/schemas/ApiBSONTimestampView"
        doNotDelete:
          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.'
          type: boolean
        expires:
          description: 'Date and time when MongoDB Cloud deletes the snapshot. If
            `"doNotDelete" : true`, MongoDB Cloud removes any value set for this parameter.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.'
          format: date-time
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns the snapshots.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        incremental:
          description: Flag indicating if this is an incremental or a full snapshot.
          readOnly: true
          type: boolean
        lastOplogAppliedTimestamp:
          "$ref": "#/components/schemas/ApiBSONTimestampView"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        parts:
          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
          type: array
      type: object
    BackupSnapshotPart:
      description: Characteristics that identify this snapshot.
      properties:
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the snapshots you want to return.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        completedTime:
          description: Date and time when the snapshot completed. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        compressionSetting:
          description: Human-readable label that identifies the method of compression
            for the snapshot.
          enum:
          - NONE
          - GZIP
          readOnly: true
          type: string
        dataSizeBytes:
          description: Total size of the data stored on each node in the cluster.
            This parameter expresses its value in bytes.
          format: int64
          readOnly: true
          type: integer
        encryptionEnabled:
          description: Flag that indicates whether someone encrypted this snapshot.
          readOnly: true
          type: boolean
        fcv:
          description: Number that indicates the feature compatibility version of
            MongoDB that the replica set primary ran when MongoDB Cloud created the
            snapshot.
          readOnly: true
          type: string
        fileSizeBytes:
          description: Number that indicates the total size of the data files in bytes.
          format: int64
          readOnly: true
          type: integer
        machineId:
          description: Hostname and port that indicate the node on which MongoDB Cloud
            created the snapshot.
          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
          type: string
        masterKeyUUID:
          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`.'
          format: uuid
          readOnly: true
          type: string
        mongodVersion:
          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
          type: string
        replicaSetName:
          description: Human-readable label that identifies the replica set.
          readOnly: true
          type: string
        replicaState:
          description: The node's role at the time when snapshot process began.
          readOnly: true
          type: string
        storageSizeBytes:
          description: Number that indicates the total size of space allocated for
            document storage.
          format: int64
          readOnly: true
          type: integer
        typeName:
          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
          - CONFIG_SHARD_REPLICA_SET
          readOnly: true
          type: string
      readOnly: true
      title: Snapshot Components
      type: object
    BackupSnapshotRetention:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        retentionUnit:
          description: Quantity of time in which MongoDB Cloud measures snapshot retention.
          enum:
          - DAYS
          - WEEKS
          - MONTHS
          - YEARS
          type: string
        retentionValue:
          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
          format: int32
          type: integer
      required:
      - retentionUnit
      - retentionValue
      type: object
    BadRequestDetail:
      description: Bad request detail.
      properties:
        fields:
          description: Describes all violations in a client request.
          items:
            "$ref": "#/components/schemas/FieldViolation"
          type: array
      readOnly: true
      type: object
    BaseAtlasDataLakeRegion:
      description: Name of the region to which the data lake routes client connections.
      oneOf:
      - "$ref": "#/components/schemas/ApiAtlasDataLakeAWSRegionView"
      - "$ref": "#/components/schemas/AtlasDataFederationAzureRegion"
      - "$ref": "#/components/schemas/AtlasDataFederationGCPRegion"
      type: object
    BaseCloudProviderInstanceSize:
      description: Instance size boundary to which your cluster can automatically
        scale.
      oneOf:
      - enum:
        - M10
        - M20
        - M30
        - M40
        - M50
        - M60
        - M80
        - M100
        - M140
        - M200
        - M300
        - R40
        - R50
        - R60
        - R80
        - R200
        - R300
        - R400
        - R700
        - M40_NVME
        - M50_NVME
        - M60_NVME
        - M80_NVME
        - M200_NVME
        - M400_NVME
        title: AWS Instance Sizes
        type: string
      - enum:
        - M10
        - M20
        - M30
        - M40
        - M50
        - M60
        - M80
        - M90
        - M200
        - R40
        - R50
        - R60
        - R80
        - R200
        - R300
        - R400
        - M60_NVME
        - M80_NVME
        - M200_NVME
        - M300_NVME
        - M400_NVME
        - M600_NVME
        title: Azure Instance Sizes
        type: string
      - enum:
        - M10
        - M20
        - M30
        - M40
        - M50
        - M60
        - M80
        - M140
        - M200
        - M250
        - M300
        - M400
        - R40
        - R50
        - R60
        - R80
        - R200
        - R300
        - R400
        - R600
        title: GCP Instance Sizes
        type: string
      readOnly: true
      type: object
    BaseNetworkPeeringConnectionSettings:
      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:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        providerName:
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      required:
      - containerId
      type: object
    BaseStreamsRegion:
      description: Name of the cloud provider region hosting Atlas Stream Processing.
      oneOf:
      - "$ref": "#/components/schemas/ApiStreamsAWSRegionView"
      - "$ref": "#/components/schemas/ApiStreamsAzureRegionView"
      - "$ref": "#/components/schemas/ApiStreamsGCPRegionView"
      type: object
    BasicDBObject:
      additionalProperties:
        type: object
      type: object
    BiConnector:
      description: Settings needed to configure the MongoDB Connector for Business
        Intelligence for this cluster.
      externalDocs:
        description: MongoDB Connector for Business Intelligence
        url: https://docs.mongodb.com/bi-connector/current/
      properties:
        enabled:
          description: Flag that indicates whether MongoDB Connector for Business
            Intelligence is enabled on the specified cluster.
          type: boolean
        readPreference:
          description: Data source node designated for the MongoDB Connector for Business
            Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence
            on MongoDB Cloud reads data from the primary, secondary, or analytics
            node based on your read preferences. Defaults to `ANALYTICS` node, or
            `SECONDARY` if there are no `ANALYTICS` nodes.
          enum:
          - PRIMARY
          - SECONDARY
          - ANALYTICS
          externalDocs:
            description: Read preferences for BI Connector
            url: https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences
          type: string
      title: MongoDB Connector for Business Intelligence Settings
      type: object
    BillingEventTypeViewAlertableWithThreshold:
      description: Event type that triggers an alert.
      enum:
      - PENDING_INVOICE_OVER_THRESHOLD
      - DAILY_BILL_OVER_THRESHOLD
      - DAILY_BILLING_CHANGE_OVER_THRESHOLD
      - WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
      - MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
      example: PENDING_INVOICE_OVER_THRESHOLD
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Billing Event Type
      type: string
    BillingEventTypeViewForNdsGroup:
      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
      - DAILY_BILLING_CHANGE_NORMAL
      - DAILY_BILLING_CHANGE_OVER_THRESHOLD
      - WEEKLY_BILLING_CHANGE_NORMAL
      - WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
      - MONTHLY_BILLING_CHANGE_NORMAL
      - MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
      example: CREDIT_CARD_CURRENT
      title: Billing Event Types
      type: string
    BillingEventTypeViewForOrg:
      description: Unique identifier of event type.
      enum:
      - AWS_PAYMENT_PAID
      - 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_SFOLID_MODIFIED
      - PREPAID_PLAN_MODIFIED
      - AWS_USAGE_REPORTED
      - AZURE_USAGE_REPORTED
      - GCP_USAGE_REPORTED
      - VERCEL_USAGE_REPORTED
      - BECAME_PAYING_ORG
      - BECAME_LINKED_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
      - EVERGREEN_PRIORITY_MODIFIED
      - CROSS_ORG_OPERATION_TICKET_TRACKING
      - ADMIN_OVERRIDE_PAYMENT_METHOD_DELETED
      - ADMIN_OVERRIDE_PAYMENT_METHOD_EXPIRED
      - PAYMENT_METHOD_FLAGGED
      - PAYMENT_METHOD_UNFLAGGED
      - MARKETPLACE_REFUND_ISSUED
      - PAYMENT_DUE_DATE_EXTENDED
      example: CHARGE_SUCCEEDED
      title: Billing Event Types
      type: string
    BillingEventViewForNdsGroup:
      description: Billing event identifies different activities related to billing,
        payment or financial status change of an organization.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/BillingEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        invoiceId:
          description: Unique 24-hexadecimal digit string that identifies of the invoice
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        paymentId:
          description: Unique 24-hexadecimal digit string that identifies the invoice
            payment associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Billing Events
      type: object
    BillingEventViewForOrg:
      description: Billing event identifies different activities related to billing,
        payment or financial status change of an organization.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/BillingEventTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        invoiceId:
          description: Unique 24-hexadecimal digit string that identifies of the invoice
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        paymentId:
          description: Unique 24-hexadecimal digit string that identifies the invoice
            payment associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Billing Events
      type: object
    BillingInvoice:
      properties:
        amountBilledCents:
          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).
          format: int64
          readOnly: true
          type: integer
        amountPaidCents:
          description: Sum that the specified organization paid toward this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        created:
          description: Date and time when MongoDB Cloud created this invoice. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        creditsCents:
          description: Sum that MongoDB credited the specified organization toward
            this invoice. This parameter expresses its value in cents (100ths of one
            US Dollar).
          format: int64
          readOnly: true
          type: integer
        endDate:
          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.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the invoice
            submitted to the specified organization. Charges typically post the next
            day.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lineItems:
          description: List that contains individual services included in this invoice.
          items:
            "$ref": "#/components/schemas/InvoiceLineItem"
          readOnly: true
          type: array
        linkedInvoices:
          description: List that contains the invoices for organizations linked to
            the paying organization.
          items:
            "$ref": "#/components/schemas/BillingInvoice"
          readOnly: true
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            charged for services consumed from MongoDB Cloud.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        payments:
          description: List that contains funds transferred to MongoDB to cover the
            specified service noted in this invoice.
          items:
            "$ref": "#/components/schemas/BillingPayment"
          readOnly: true
          type: array
        refunds:
          description: List that contains payments that MongoDB returned to the organization
            for this invoice.
          items:
            "$ref": "#/components/schemas/BillingRefund"
          readOnly: true
          type: array
        salesTaxCents:
          description: Sum of sales tax applied to this invoice. This parameter expresses
            its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        startDate:
          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.
          format: date-time
          readOnly: true
          type: string
        startingBalanceCents:
          description: Sum that the specified organization owed to MongoDB when MongoDB
            issued this invoice. This parameter expresses its value in US Dollars.
          format: int64
          readOnly: true
          type: integer
        statusName:
          description: |-
            Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:

            - `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
          type: string
        subtotalCents:
          description: Sum of all positive invoice line items contained in this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        updated:
          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.
          format: date-time
          readOnly: true
          type: string
      type: object
    BillingInvoiceMetadata:
      properties:
        amountBilledCents:
          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).
          format: int64
          readOnly: true
          type: integer
        amountPaidCents:
          description: Sum that the specified organization paid toward this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        created:
          description: Date and time when MongoDB Cloud created this invoice. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        creditsCents:
          description: Sum that MongoDB credited the specified organization toward
            this invoice. This parameter expresses its value in cents (100ths of one
            US Dollar).
          format: int64
          readOnly: true
          type: integer
        endDate:
          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.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the invoice
            submitted to the specified organization. Charges typically post the next
            day.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        linkedInvoices:
          description: List that contains the invoices for organizations linked to
            the paying organization.
          items:
            "$ref": "#/components/schemas/BillingInvoiceMetadata"
          readOnly: true
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            charged for services consumed from MongoDB Cloud.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        salesTaxCents:
          description: Sum of sales tax applied to this invoice. This parameter expresses
            its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        startDate:
          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.
          format: date-time
          readOnly: true
          type: string
        startingBalanceCents:
          description: Sum that the specified organization owed to MongoDB when MongoDB
            issued this invoice. This parameter expresses its value in US Dollars.
          format: int64
          readOnly: true
          type: integer
        statusName:
          description: |-
            Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:

            - `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
          type: string
        subtotalCents:
          description: Sum of all positive invoice line items contained in this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        updated:
          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.
          format: date-time
          readOnly: true
          type: string
      type: object
    BillingPayment:
      description: Funds transferred to MongoDB to cover the specified service in
        this invoice.
      properties:
        amountBilledCents:
          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).
          format: int64
          readOnly: true
          type: integer
        amountPaidCents:
          description: Sum that the specified organization paid toward the associated
            invoice. This parameter expresses its value in cents (100ths of one US
            Dollar).
          format: int64
          readOnly: true
          type: integer
        created:
          description: Date and time when the customer made this payment attempt.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        currency:
          description: The currency in which payment was paid. This parameter expresses
            its value in 3-letter ISO 4217 currency code.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this payment
            toward the associated invoice.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        salesTaxCents:
          description: Sum of sales tax applied to this invoice. This parameter expresses
            its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        statusName:
          description: |-
            Phase of payment processing for the associated invoice when you made this request. These phases include:

            - `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
          - FAILED_AUTHENTICATION
          - PROCESSING
          - PENDING_REVERSAL
          - REFUNDED
          type: string
        subtotalCents:
          description: Sum of all positive invoice line items contained in this invoice.
            This parameter expresses its value in cents (100ths of one US Dollar).
          format: int64
          readOnly: true
          type: integer
        unitPrice:
          description: The unit price applied to `amountBilledCents` to compute total
            payment amount. This value is represented as a decimal string.
          readOnly: true
          type: string
        updated:
          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.
          format: date-time
          readOnly: true
          type: string
      title: Payment
      type: object
    BillingRefund:
      description: One payment that MongoDB returned to the organization for this
        invoice.
      properties:
        amountCents:
          description: Sum of the funds returned to the specified organization expressed
            in cents (100th of US Dollar).
          format: int64
          readOnly: true
          type: integer
        created:
          description: Date and time when MongoDB Cloud created this refund. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        paymentId:
          description: Unique 24-hexadecimal digit string that identifies the payment
            that the organization had made.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        reason:
          description: Justification that MongoDB accepted to return funds to the
            organization.
          readOnly: true
          type: string
      title: Refund
      type: object
    BillingThresholdAlertConfigViewForNdsGroup:
      description: Billing threshold alert configuration allows to select thresholds
        for bills and invoices which trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/BillingEventTypeViewAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/GreaterThanRawThreshold"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Billing Threshold Alert Configuration
      type: object
    CacheBytesReadIntoDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    CacheBytesWrittenFromDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    CacheUsageDirtyDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    CacheUsageUsedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    ChartsAudit:
      description: Audit events related to Atlas Charts.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ChartsAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      type: object
    ChartsAuditTypeView:
      description: Unique identifier of event type.
      enum:
      - CHARTS_API_SUCCESS
      - CHARTS_API_FAILURE
      example: CHARTS_API_SUCCESS
      title: Charts Api Call Audit Types
      type: string
    CloudAccessRoleAssignment:
      description: MongoDB Cloud user's roles and the corresponding organization or
        project to which that role applies. Each role can apply to one organization
        or one project but not both.
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to which this role belongs. You can set a value for this parameter or
            `orgId` but not both in the same request.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which this role belongs. You can set a value for this parameter or
            `groupId` but not both in the same request.
          example: 32b6e34b3d91647abb20e7b8
          maxLength: 24
          minLength: 24
          pattern: "^([a-f0-9]{24})$"
          type: string
        roleName:
          description: Human-readable label that identifies the collection of privileges
            that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB
            Cloud team. These roles include organization- and project-level roles.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          type: string
      title: Role Assignment
      type: object
    CloudAppUser:
      properties:
        country:
          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})$"
          type: string
        createdAt:
          description: Date and time when the current account is created. This value
            is in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        emailAddress:
          deprecated: true
          description: Email address that belongs to the MongoDB Cloud user.
          format: email
          readOnly: true
          type: string
        firstName:
          description: First or given name that belongs to the MongoDB Cloud user.
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastAuth:
          description: Date and time when the current account last authenticated.
            This value is in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        lastName:
          description: Last name, family name, or surname that belongs to the MongoDB
            Cloud user.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mobileNumber:
          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})$"
          type: string
        password:
          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.
          format: password
          minLength: 8
          type: string
        roles:
          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"
          type: array
        teamIds:
          description: List of unique 24-hexadecimal digit strings that identifies
            the teams to which this MongoDB Cloud user belongs.
          items:
            description: Unique 24-hexadecimal digit string that identifies the team
              to which this MongoDB Cloud user belongs.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          readOnly: true
          type: array
          uniqueItems: true
        username:
          description: Email address that represents the username of the MongoDB Cloud
            user.
          format: email
          type: string
      required:
      - country
      - emailAddress
      - firstName
      - lastName
      - mobileNumber
      - password
      - roles
      - username
      type: object
    CloudCluster:
      description: Settings that describe the clusters in each project that the API
        key is authorized to view.
      properties:
        alertCount:
          description: Whole number that indicates the quantity of alerts open on
            the cluster.
          format: int32
          readOnly: true
          type: integer
        authEnabled:
          description: Flag that indicates whether authentication is required to access
            the nodes in this cluster.
          readOnly: true
          type: boolean
        availability:
          description: Term that expresses how many nodes of the cluster can be accessed
            when MongoDB Cloud receives this request. This parameter returns `available`
            when all nodes are accessible, `warning` only when some nodes in the cluster
            can be accessed, `unavailable` when the cluster can't be accessed, or
            `dead` when the cluster has been deactivated.
          enum:
          - available
          - dead
          - unavailable
          - warning
          readOnly: true
          type: string
        backupEnabled:
          description: Flag that indicates whether the cluster can perform backups.
            If set to `true`, the cluster can perform backups. You must set this value
            to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters
            and Shared Cluster Backups for tenant clusters. If set to `false`, the
            cluster doesn't use MongoDB Cloud backups.
          readOnly: true
          type: boolean
        clusterId:
          description: Unique 24-hexadecimal character string that identifies the
            cluster. Each `clusterId` is used only once across all MongoDB Cloud deployments.
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        dataSizeBytes:
          description: Total size of the data stored on each node in the cluster.
            The resource expresses this value in bytes.
          format: int64
          readOnly: true
          type: integer
        name:
          description: Human-readable label that identifies the cluster.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        nodeCount:
          description: Whole number that indicates the quantity of nodes that comprise
            the cluster.
          format: int32
          readOnly: true
          type: integer
        sslEnabled:
          description: Flag that indicates whether TLS authentication is required
            to access the nodes in this cluster.
          readOnly: true
          type: boolean
        type:
          description: Human-readable label that indicates the cluster type.
          enum:
          - REPLICA_SET
          - SHARDED_CLUSTER
          readOnly: true
          type: string
        versions:
          description: List that contains the versions of MongoDB that each node in
            the cluster runs.
          items:
            type: string
          readOnly: true
          type: array
          uniqueItems: true
      readOnly: true
      type: object
    CloudDatabaseUser:
      properties:
        awsIAMType:
          default: NONE
          description: Human-readable label that indicates whether the new database
            user authenticates with the Amazon Web Services (AWS) Identity and Access
            Management (IAM) credentials associated with the user or the user's role.
          enum:
          - NONE
          - USER
          - ROLE
          type: string
        databaseName:
          default: admin
          description: 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, LDAP,
            or OIDC Workload this value should be `$external`. If the user authenticates
            with SCRAM-SHA or OIDC Workforce, this value should be `admin`.
          enum:
          - admin
          - "$external"
          type: string
        deleteAfterDate:
          description: Date and time when MongoDB Cloud deletes the user. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC and can include
            the time zone designation. You must specify a future date that falls within
            one week of making the Application Programming Interface (API) request.
          format: date-time
          type: string
        description:
          description: Description of this database user.
          maxLength: 100
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project.
          type: string
          writeOnly: true
        labels:
          description: List that contains the key-value pairs for tagging and categorizing
            the MongoDB database user. The labels that you define do not appear in
            the console.
          items:
            "$ref": "#/components/schemas/ComponentLabel"
          type: array
        ldapAuthType:
          default: NONE
          description: Part of the Lightweight Directory Access Protocol (LDAP) record
            that the database uses to authenticate this database user on the LDAP
            host.
          enum:
          - NONE
          - GROUP
          - USER
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        oidcAuthType:
          default: NONE
          description: Human-readable label that indicates whether the new database
            user or group authenticates with OIDC federated authentication. To create
            a federated authentication user, specify the value of USER in this field.
            To create a federated authentication group, specify the value of `IDP_GROUP`
            in this field.
          enum:
          - NONE
          - IDP_GROUP
          - USER
          type: string
        password:
          description: Alphanumeric string that authenticates this database user against
            the database specified in `databaseName`. To authenticate with SCRAM-SHA,
            you must specify this parameter. This parameter doesn't appear in this
            response.
          externalDocs:
            description: SCRAM-SHA
            url: https://docs.mongodb.com/manual/core/security-scram/
          minLength: 8
          type: string
          writeOnly: true
        roles:
          description: List that provides the pairings of one role with one applicable
            database.
          items:
            "$ref": "#/components/schemas/DatabaseUserRole"
          type: array
        scopes:
          description: List that contains clusters, MongoDB Atlas Data Lakes, and
            MongoDB Atlas Streams Workspaces that this database user can access. If
            omitted, MongoDB Cloud grants the database user access to all the clusters,
            MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Workspaces in the
            project.
          items:
            "$ref": "#/components/schemas/UserScope"
          type: array
        username:
          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 | `awsIAMType` | `ROLE` | <abbr title="Amazon Resource Name">ARN</abbr> |
            | AWS IAM | `awsIAMType` | `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 Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
            | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |
            | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |
          maxLength: 1024
          type: string
        x509Type:
          default: NONE
          description: |-
            X.509 method that MongoDB Cloud uses to authenticate the database user.

            - For application-managed X.509, specify `MANAGED`.
            - For self-managed X.509, specify `CUSTOMER`.

            Users created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.
          enum:
          - NONE
          - CUSTOMER
          - MANAGED
          type: string
      required:
      - databaseName
      - groupId
      - roles
      - username
      type: object
    CloudGCPProviderSettings:
      allOf:
      - "$ref": "#/components/schemas/ClusterProviderSettings"
      - properties:
          autoScaling:
            "$ref": "#/components/schemas/CloudProviderGCPAutoScaling"
          instanceSizeName:
            description: Cluster tier, with a default storage and memory capacity,
              that applies to all the data-bearing hosts in your cluster.
            enum:
            - M10
            - M20
            - M30
            - M40
            - M50
            - M60
            - M80
            - M140
            - M200
            - M250
            - M300
            - M400
            - R40
            - R50
            - R60
            - R80
            - R200
            - R300
            - R400
            - R600
            title: GCP Instance Sizes
            type: string
          regionName:
            description: Google Compute Regions.
            enum:
            - EASTERN_US
            - EASTERN_US_AW
            - US_EAST_4
            - US_EAST_4_AW
            - US_EAST_5
            - US_EAST_5_AW
            - US_WEST_2
            - US_WEST_2_AW
            - US_WEST_3
            - US_WEST_3_AW
            - US_WEST_4
            - US_WEST_4_AW
            - US_SOUTH_1
            - US_SOUTH_1_AW
            - CENTRAL_US
            - CENTRAL_US_AW
            - WESTERN_US
            - WESTERN_US_AW
            - NORTH_AMERICA_NORTHEAST_1
            - NORTH_AMERICA_NORTHEAST_2
            - NORTH_AMERICA_SOUTH_1
            - SOUTH_AMERICA_EAST_1
            - SOUTH_AMERICA_WEST_1
            - WESTERN_EUROPE
            - EUROPE_NORTH_1
            - EUROPE_WEST_2
            - EUROPE_WEST_3
            - EUROPE_WEST_4
            - EUROPE_WEST_6
            - EUROPE_WEST_8
            - EUROPE_WEST_9
            - EUROPE_WEST_10
            - EUROPE_WEST_12
            - EUROPE_SOUTHWEST_1
            - EUROPE_CENTRAL_2
            - MIDDLE_EAST_CENTRAL_1
            - MIDDLE_EAST_CENTRAL_2
            - MIDDLE_EAST_WEST_1
            - AUSTRALIA_SOUTHEAST_1
            - AUSTRALIA_SOUTHEAST_2
            - AFRICA_SOUTH_1
            - EASTERN_ASIA_PACIFIC
            - NORTHEASTERN_ASIA_PACIFIC
            - SOUTHEASTERN_ASIA_PACIFIC
            - ASIA_EAST_2
            - ASIA_NORTHEAST_2
            - ASIA_NORTHEAST_3
            - ASIA_SOUTH_1
            - ASIA_SOUTH_2
            - ASIA_SOUTHEAST_2
            externalDocs:
              description: GCP
              url: https://docs.atlas.mongodb.com/reference/google-gcp/
            title: GCP Regions
            type: string
        type: object
      type: object
    CloudProviderAWSAutoScaling:
      description: Range of instance sizes to which your cluster can scale.
      properties:
        compute:
          "$ref": "#/components/schemas/AWSComputeAutoScaling"
      type: object
    CloudProviderAccessAWSIAMRole:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessRole"
      - properties:
          atlasAWSAccountArn:
            description: Amazon Resource Name that identifies the Amazon Web Services
              (AWS) user account that MongoDB Cloud uses when it assumes the Identity
              and Access Management (IAM) role.
            example: arn:aws:iam::772401394250:role/my-test-aws-role
            maxLength: 2048
            minLength: 20
            readOnly: true
            type: string
          atlasAssumedRoleExternalId:
            description: Unique external ID that MongoDB Cloud uses when it assumes
              the IAM role in your Amazon Web Services (AWS) account.
            format: uuid
            readOnly: true
            type: string
          authorizedDate:
            description: Date and time when someone authorized this role for the specified
              cloud service provider. This parameter expresses its value in the ISO
              8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          createdDate:
            description: Date and time when someone created this role for the specified
              cloud service provider. This parameter expresses its value in the ISO
              8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          featureUsages:
            description: List that contains application features associated with this
              Amazon Web Services (AWS) Identity and Access Management (IAM) role.
            items:
              "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
            readOnly: true
            type: array
          iamAssumedRoleArn:
            description: Amazon Resource Name (ARN) that identifies the Amazon Web
              Services (AWS) Identity and Access Management (IAM) role that MongoDB
              Cloud assumes when it accesses resources in your AWS account.
            example: arn:aws:iam::123456789012:root
            maxLength: 2048
            minLength: 20
            type: string
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the role.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
        type: object
      description: Details that describe the features linked to the Amazon Web Services
        (AWS) Identity and Access Management (IAM) role.
      required:
      - providerName
      type: object
    CloudProviderAccessAWSIAMRoleRequest:
      description: Details that describe the features linked to the Amazon Web Services
        (AWS) Identity and Access Management (IAM) role.
      properties:
        atlasAWSAccountArn:
          description: Amazon Resource Name that identifies the Amazon Web Services
            (AWS) user account that MongoDB Cloud uses when it assumes the Identity
            and Access Management (IAM) role.
          example: arn:aws:iam::772401394250:role/my-test-aws-role
          maxLength: 2048
          minLength: 20
          readOnly: true
          type: string
        atlasAssumedRoleExternalId:
          description: Unique external ID that MongoDB Cloud uses when it assumes
            the IAM role in your Amazon Web Services (AWS) account.
          format: uuid
          readOnly: true
          type: string
        authorizedDate:
          description: Date and time when someone authorized this role for the specified
            cloud service provider. This parameter expresses its value in the ISO
            8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        createdDate:
          description: Date and time when someone created this role for the specified
            cloud service provider. This parameter expresses its value in the ISO
            8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        featureUsages:
          description: List that contains application features associated with this
            Amazon Web Services (AWS) Identity and Access Management (IAM) role.
          items:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
          readOnly: true
          type: array
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the role.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        roleId:
          description: Unique 24-hexadecimal digit string that identifies the role.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      required:
      - providerName
      type: object
    CloudProviderAccessAWSIAMRoleRequestUpdate:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate"
      - properties:
          atlasAWSAccountArn:
            description: Amazon Resource Name that identifies the Amazon Web Services
              (AWS) user account that MongoDB Cloud uses when it assumes the Identity
              and Access Management (IAM) role.
            example: arn:aws:iam::772401394250:role/my-test-aws-role
            maxLength: 2048
            minLength: 20
            readOnly: true
            type: string
          atlasAssumedRoleExternalId:
            description: Unique external ID that MongoDB Cloud uses when it assumes
              the IAM role in your Amazon Web Services (AWS) account.
            format: uuid
            readOnly: true
            type: string
          authorizedDate:
            description: Date and time when someone authorized this role for the specified
              cloud service provider. This parameter expresses its value in the ISO
              8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          createdDate:
            description: Date and time when someone created this role for the specified
              cloud service provider. This parameter expresses its value in the ISO
              8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          featureUsages:
            description: List that contains application features associated with this
              Amazon Web Services (AWS) Identity and Access Management (IAM) role.
            items:
              "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
            readOnly: true
            type: array
          iamAssumedRoleArn:
            description: Amazon Resource Name (ARN) that identifies the Amazon Web
              Services (AWS) Identity and Access Management (IAM) role that MongoDB
              Cloud assumes when it accesses resources in your AWS account.
            example: arn:aws:iam::123456789012:root
            maxLength: 2048
            minLength: 20
            type: string
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the role.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
        type: object
      description: Details that describe the features linked to the Amazon Web Services
        (AWS) Identity and Access Management (IAM) role.
      required:
      - providerName
      type: object
    CloudProviderAccessAtlasLogIntegrationFeatureUsage:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
      - properties:
          featureId:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsageAtlasLogIntegrationFeatureId"
        type: object
      description: Details that describe the Atlas log integration linked to this
        cloud provider access role.
      type: object
    CloudProviderAccessAzureServicePrincipal:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessRole"
      - properties:
          _id:
            description: Unique 24-hexadecimal digit string that identifies the role.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          atlasAzureAppId:
            description: Azure Active Directory Application ID of Atlas. This field
              is optional and will be derived from the Azure subscription if not provided.
            format: uuid
            type: string
          createdDate:
            description: Date and time when this Azure Service Principal was created.
              This parameter expresses its value in the ISO 8601 timestamp format
              in UTC.
            format: date-time
            readOnly: true
            type: string
          featureUsages:
            description: List that contains application features associated with this
              Azure Service Principal.
            items:
              "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
            readOnly: true
            type: array
          lastUpdatedDate:
            description: Date and time when this Azure Service Principal was last
              updated. This parameter expresses its value in the ISO 8601 timestamp
              format in UTC.
            format: date-time
            readOnly: true
            type: string
          servicePrincipalId:
            description: UUID string that identifies the Azure Service Principal.
            format: uuid
            type: string
          tenantId:
            description: UUID String that identifies the Azure Active Directory Tenant
              ID.
            format: uuid
            type: string
        type: object
      description: Details that describe the features linked to the Azure Service
        Principal.
      required:
      - providerName
      type: object
    CloudProviderAccessAzureServicePrincipalRequest:
      description: Details that describe the features linked to the Azure Service
        Principal.
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the role.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        atlasAzureAppId:
          description: Azure Active Directory Application ID of Atlas. This field
            is optional and will be derived from the Azure subscription if not provided.
          format: uuid
          type: string
        createdDate:
          description: Date and time when this Azure Service Principal was created.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        featureUsages:
          description: List that contains application features associated with this
            Azure Service Principal.
          items:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
          readOnly: true
          type: array
        lastUpdatedDate:
          description: Date and time when this Azure Service Principal was last updated.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the role.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        servicePrincipalId:
          description: UUID string that identifies the Azure Service Principal.
          format: uuid
          type: string
        tenantId:
          description: UUID String that identifies the Azure Active Directory Tenant
            ID.
          format: uuid
          type: string
      required:
      - providerName
      type: object
    CloudProviderAccessAzureServicePrincipalRequestUpdate:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate"
      - properties:
          _id:
            description: Unique 24-hexadecimal digit string that identifies the role.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          atlasAzureAppId:
            description: Azure Active Directory Application ID of Atlas. This field
              is optional and will be derived from the Azure subscription if not provided.
            format: uuid
            type: string
          createdDate:
            description: Date and time when this Azure Service Principal was created.
              This parameter expresses its value in the ISO 8601 timestamp format
              in UTC.
            format: date-time
            readOnly: true
            type: string
          featureUsages:
            description: List that contains application features associated with this
              Azure Service Principal.
            items:
              "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
            readOnly: true
            type: array
          lastUpdatedDate:
            description: Date and time when this Azure Service Principal was last
              updated. This parameter expresses its value in the ISO 8601 timestamp
              format in UTC.
            format: date-time
            readOnly: true
            type: string
          servicePrincipalId:
            description: UUID string that identifies the Azure Service Principal.
            format: uuid
            type: string
          tenantId:
            description: UUID String that identifies the Azure Active Directory Tenant
              ID.
            format: uuid
            type: string
        type: object
      description: Details that describe the features linked to the Azure Service
        Principal.
      required:
      - providerName
      type: object
    CloudProviderAccessDataLakeFeatureUsage:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
      - properties:
          featureId:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId"
        type: object
      description: Details that describe the Atlas Data Lakes linked to this Amazon
        Web Services (AWS) Identity and Access Management (IAM) role.
      type: object
    CloudProviderAccessEncryptionAtRestFeatureUsage:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
      - properties:
          featureId:
            "$ref": "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView"
        type: object
      description: Details that describe the Key Management Service (KMS) linked to
        this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
      type: object
    CloudProviderAccessExportSnapshotFeatureUsage:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
      - properties:
          featureId:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId"
        type: object
      description: Details that describe the Amazon Web Services (AWS) Simple Storage
        Service (S3) export buckets linked to this AWS Identity and Access Management
        (IAM) role.
      type: object
    CloudProviderAccessFeatureUsage:
      description: MongoDB Cloud features associated with this Amazon Web Services
        (AWS) Identity and Access Management (IAM) role.
      discriminator:
        mapping:
          ATLAS_DATA_LAKE: "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage"
          ATLAS_LOG_INTEGRATION: "#/components/schemas/CloudProviderAccessAtlasLogIntegrationFeatureUsage"
          ENCRYPTION_AT_REST: "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage"
          EXPORT_SNAPSHOT: "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage"
          PUSH_BASED_LOG_EXPORT: "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage"
        propertyName: featureType
      properties:
        featureType:
          description: Human-readable label that describes one MongoDB Cloud feature
            linked to this Amazon Web Services (AWS) Identity and Access Management
            (IAM) role.
          enum:
          - ATLAS_DATA_LAKE
          - ENCRYPTION_AT_REST
          - EXPORT_SNAPSHOT
          - PUSH_BASED_LOG_EXPORT
          - ATLAS_LOG_INTEGRATION
          readOnly: true
          type: string
      type: object
    CloudProviderAccessFeatureUsageAtlasLogIntegrationFeatureId:
      description: Identifying characteristics about the Atlas log integration linked
        to this cloud provider access role.
      properties:
        configId:
          description: Unique 24-hexadecimal digit string that identifies the Atlas
            log integration configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies your project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        sinkName:
          description: Human-readable label that identifies the sink, such as an S3/GCS
            bucket or Azure container name.
          readOnly: true
          type: string
      type: object
    CloudProviderAccessFeatureUsageDataLakeFeatureId:
      description: Identifying characteristics about the data lake linked to this
        Amazon Web Services (AWS) Identity and Access Management (IAM) role.
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies your project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the data lake.
          type: string
      type: object
    CloudProviderAccessFeatureUsageExportSnapshotFeatureId:
      description: Identifying characteristics about the Amazon Web Services (AWS)
        Simple Storage Service (S3) export bucket linked to this AWS Identity and
        Access Management (IAM) role.
      properties:
        exportBucketId:
          description: Unique 24-hexadecimal digit string that identifies the AWS
            S3 bucket to which you export your snapshots.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies your project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      type: object
    CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId:
      description: Identifying characteristics about the Amazon Web Services (AWS)
        Simple Storage Service (S3) export bucket linked to this AWS Identity and
        Access Management (IAM) role.
      properties:
        bucketName:
          description: Name of the AWS S3 bucket to which your logs will be exported
            to.
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies your project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      type: object
    CloudProviderAccessGCPServiceAccount:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessRole"
      - properties:
          createdDate:
            description: Date and time when this Google Service Account was created.
              This parameter expresses its value in the ISO 8601 timestamp format
              in UTC.
            format: date-time
            readOnly: true
            type: string
          featureUsages:
            description: List that contains application features associated with this
              Google Service Account.
            items:
              "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
            readOnly: true
            type: array
          gcpServiceAccountForAtlas:
            description: Email address for the Google Service Account created by Atlas.
            pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$"
            type: string
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the role.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          status:
            description: Provision status of the service account.
            enum:
            - IN_PROGRESS
            - COMPLETE
            - FAILED
            - NOT_INITIATED
            readOnly: true
            type: string
        type: object
      description: Details that describe the features linked to the GCP Service Account.
      required:
      - providerName
      type: object
    CloudProviderAccessGCPServiceAccountRequest:
      description: Details that describe the features linked to the GCP Service Account.
      properties:
        createdDate:
          description: Date and time when this GCP Service Account was created. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        featureUsages:
          description: List that contains application features associated with this
            GCP Service Account.
          items:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
          readOnly: true
          type: array
        gcpServiceAccountForAtlas:
          description: ID string that identifies the GCP Service Account used by Atlas.
          readOnly: true
          type: string
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the role.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        roleId:
          description: Unique 24-hexadecimal digit string that identifies the role.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      required:
      - providerName
      type: object
    CloudProviderAccessGCPServiceAccountRequestUpdate:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate"
      description: Details that describe the features linked to the GCP Service Account.
      required:
      - providerName
      type: object
    CloudProviderAccessPushBasedLogExportFeatureUsage:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage"
      - properties:
          featureId:
            "$ref": "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId"
        type: object
      description: Details that describe the Amazon Web Services (AWS) Simple Storage
        Service (S3) export buckets linked to this AWS Identity and Access Management
        (IAM) role.
      type: object
    CloudProviderAccessRole:
      description: Cloud provider access role.
      discriminator:
        mapping:
          AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole"
          AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal"
          GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount"
        propertyName: providerName
      oneOf:
      - "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRole"
      - "$ref": "#/components/schemas/CloudProviderAccessAzureServicePrincipal"
      - "$ref": "#/components/schemas/CloudProviderAccessGCPServiceAccount"
      properties:
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the role.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      required:
      - providerName
      type: object
    CloudProviderAccessRoleRequest:
      description: Cloud provider access role.
      discriminator:
        mapping:
          AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest"
          AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest"
          GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest"
        propertyName: providerName
      oneOf:
      - "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest"
      - "$ref": "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest"
      - "$ref": "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest"
      properties:
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the role.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      required:
      - providerName
      type: object
    CloudProviderAccessRoleRequestUpdate:
      description: Cloud provider access role.
      discriminator:
        mapping:
          AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate"
          AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate"
          GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate"
        propertyName: providerName
      properties:
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the role.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      required:
      - providerName
      type: object
    CloudProviderAccessRoles:
      properties:
        awsIamRoles:
          description: List that contains the Amazon Web Services (AWS) IAM roles
            registered and authorized with MongoDB Cloud.
          items:
            "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRole"
          type: array
        azureServicePrincipals:
          description: List that contains the Azure Service Principals registered
            with MongoDB Cloud.
          items:
            "$ref": "#/components/schemas/CloudProviderAccessAzureServicePrincipal"
          type: array
        gcpServiceAccounts:
          description: List that contains the Google Service Accounts registered and
            authorized with MongoDB Cloud.
          items:
            "$ref": "#/components/schemas/CloudProviderAccessGCPServiceAccount"
          type: array
      type: object
    CloudProviderAzureAutoScaling:
      description: Range of instance sizes to which your cluster can scale.
      properties:
        compute:
          "$ref": "#/components/schemas/AzureComputeAutoScalingRules"
      type: object
    CloudProviderContainer:
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSCloudProviderContainer"
          AZURE: "#/components/schemas/AzureCloudProviderContainer"
          GCP: "#/components/schemas/GCPCloudProviderContainer"
        propertyName: providerName
      oneOf:
      - "$ref": "#/components/schemas/AzureCloudProviderContainer"
      - "$ref": "#/components/schemas/GCPCloudProviderContainer"
      - "$ref": "#/components/schemas/AWSCloudProviderContainer"
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the network
            peering container.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        providerName:
          description: Cloud service provider that serves the requested network peering
            containers.
          enum:
          - AWS
          - GCP
          - AZURE
          - TENANT
          - SERVERLESS
          type: string
        provisioned:
          description: Flag that indicates whether MongoDB Cloud clusters exist in
            the specified network peering container.
          readOnly: true
          type: boolean
      type: object
    CloudProviderEndpointServiceRequest:
      properties:
        portMappingEnabled:
          default: false
          description: Flag that indicates whether this endpoint service uses PSC
            port-mapping. This is only applicable for GCP Private Endpoint Services.
          type: boolean
          writeOnly: true
        providerName:
          description: Human-readable label that identifies the cloud service provider
            for which you want to create the private endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
          writeOnly: true
        region:
          description: Cloud provider region in which you want to create the private
            endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/),
            [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/),
            and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
          type: string
          writeOnly: true
        supportedRemoteRegions:
          description: List of regions that the endpoint service supports. Native
            cross region support is implemented for AWS only.
          items:
            description: AWS region name
            type: string
          maxItems: 35
          nullable: true
          type: array
          writeOnly: true
      required:
      - providerName
      - region
      type: object
    CloudProviderGCPAutoScaling:
      description: Range of instance sizes to which your cluster can scale.
      properties:
        compute:
          "$ref": "#/components/schemas/GCPComputeAutoScaling"
      type: object
    CloudProviderRegions:
      properties:
        instanceSizes:
          description: List of instances sizes that this cloud provider supports.
          items:
            "$ref": "#/components/schemas/ClusterCloudProviderInstanceSize"
          readOnly: true
          type: array
        provider:
          description: Human-readable label that identifies the Cloud provider.
          enum:
          - AWS
          - GCP
          - AZURE
          type: string
      type: object
    CloudRegionConfig20240805:
      description: Cloud service provider on which MongoDB Cloud provisions the hosts.
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSRegionConfig20240805"
          AZURE: "#/components/schemas/AzureRegionConfig20240805"
          GCP: "#/components/schemas/GCPRegionConfig20240805"
          TENANT: "#/components/schemas/TenantRegionConfig20240805"
        propertyName: providerName
      oneOf:
      - "$ref": "#/components/schemas/AWSRegionConfig20240805"
      - "$ref": "#/components/schemas/AzureRegionConfig20240805"
      - "$ref": "#/components/schemas/GCPRegionConfig20240805"
      - "$ref": "#/components/schemas/TenantRegionConfig20240805"
      properties:
        electableSpecs:
          "$ref": "#/components/schemas/HardwareSpec20240805"
        priority:
          description: |-
            Precedence is given to this region when a primary election occurs. If your `regionConfigs` has only `readOnlySpecs`, `analyticsSpecs`, or both, set this value to `0`. If you have multiple `regionConfigs` objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.

            **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.
          format: int32
          maximum: 7
          minimum: 0
          type: integer
        providerName:
          description: Cloud service provider on which MongoDB Cloud provisions the
            hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.
          enum:
          - AWS
          - AZURE
          - GCP
          - TENANT
          type: string
        regionName:
          description: Physical location of your MongoDB cluster nodes. The region
            you choose can affect network latency for clients accessing your databases.
            The region name is only returned in the response for single-region clusters.
            When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or
            VPC connection exists for that provider and region. If not, MongoDB Cloud
            creates them as part of the deployment. It assigns the VPC a Classless
            Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection
            to one Classless Inter-Domain Routing (CIDR) block and region, create
            the connection first. Deploy the cluster after the connection starts.
            GCP Clusters and Multi-region clusters require one VPC peering connection
            for each region. MongoDB nodes can use only the peering connection that
            resides in the same region as the nodes to communicate with the peered
            VPC.
          oneOf:
          - description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_EAST_2
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_SOUTH_1
            - AP_SOUTH_2
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - ME_CENTRAL_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            title: AWS Regions
            type: string
          - description: Microsoft Azure Regions.
            enum:
            - US_CENTRAL
            - US_EAST
            - US_EAST_2
            - US_NORTH_CENTRAL
            - US_WEST
            - US_SOUTH_CENTRAL
            - EUROPE_NORTH
            - EUROPE_WEST
            - US_WEST_CENTRAL
            - US_WEST_2
            - US_WEST_3
            - CANADA_EAST
            - CANADA_CENTRAL
            - BRAZIL_SOUTH
            - BRAZIL_SOUTHEAST
            - AUSTRALIA_CENTRAL
            - AUSTRALIA_CENTRAL_2
            - AUSTRALIA_EAST
            - AUSTRALIA_SOUTH_EAST
            - GERMANY_WEST_CENTRAL
            - GERMANY_NORTH
            - SWEDEN_CENTRAL
            - SWEDEN_SOUTH
            - SWITZERLAND_NORTH
            - SWITZERLAND_WEST
            - UK_SOUTH
            - UK_WEST
            - NORWAY_EAST
            - NORWAY_WEST
            - INDIA_CENTRAL
            - INDIA_SOUTH
            - INDIA_WEST
            - CHINA_EAST
            - CHINA_NORTH
            - ASIA_EAST
            - JAPAN_EAST
            - JAPAN_WEST
            - ASIA_SOUTH_EAST
            - KOREA_CENTRAL
            - KOREA_SOUTH
            - FRANCE_CENTRAL
            - FRANCE_SOUTH
            - SOUTH_AFRICA_NORTH
            - SOUTH_AFRICA_WEST
            - UAE_CENTRAL
            - UAE_NORTH
            - QATAR_CENTRAL
            - POLAND_CENTRAL
            - ISRAEL_CENTRAL
            - ITALY_NORTH
            - SPAIN_CENTRAL
            - MEXICO_CENTRAL
            - NEW_ZEALAND_NORTH
            - US_GOV_VIRGINIA
            - US_GOV_ARIZONA
            - US_GOV_TEXAS
            title: Azure Regions
            type: string
          - description: Google Compute Regions.
            enum:
            - EASTERN_US
            - EASTERN_US_AW
            - US_EAST_4
            - US_EAST_4_AW
            - US_EAST_5
            - US_EAST_5_AW
            - US_WEST_2
            - US_WEST_2_AW
            - US_WEST_3
            - US_WEST_3_AW
            - US_WEST_4
            - US_WEST_4_AW
            - US_SOUTH_1
            - US_SOUTH_1_AW
            - CENTRAL_US
            - CENTRAL_US_AW
            - WESTERN_US
            - WESTERN_US_AW
            - NORTH_AMERICA_NORTHEAST_1
            - NORTH_AMERICA_NORTHEAST_2
            - NORTH_AMERICA_SOUTH_1
            - SOUTH_AMERICA_EAST_1
            - SOUTH_AMERICA_WEST_1
            - WESTERN_EUROPE
            - EUROPE_NORTH_1
            - EUROPE_WEST_2
            - EUROPE_WEST_3
            - EUROPE_WEST_4
            - EUROPE_WEST_6
            - EUROPE_WEST_8
            - EUROPE_WEST_9
            - EUROPE_WEST_10
            - EUROPE_WEST_12
            - EUROPE_SOUTHWEST_1
            - EUROPE_CENTRAL_2
            - MIDDLE_EAST_CENTRAL_1
            - MIDDLE_EAST_CENTRAL_2
            - MIDDLE_EAST_WEST_1
            - AUSTRALIA_SOUTHEAST_1
            - AUSTRALIA_SOUTHEAST_2
            - AFRICA_SOUTH_1
            - EASTERN_ASIA_PACIFIC
            - NORTHEASTERN_ASIA_PACIFIC
            - SOUTHEASTERN_ASIA_PACIFIC
            - ASIA_EAST_2
            - ASIA_NORTHEAST_2
            - ASIA_NORTHEAST_3
            - ASIA_SOUTH_1
            - ASIA_SOUTH_2
            - ASIA_SOUTHEAST_2
            title: GCP Regions
            type: string
          type: object
      title: Cloud Service Provider Settings
      type: object
    CloudSearchMetrics:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hardwareMetrics:
          description: List that contains all host compute, memory, and storage utilization
            dedicated to Atlas Search when MongoDB Atlas received this request.
          items:
            "$ref": "#/components/schemas/FTSMetric"
          readOnly: true
          type: array
        indexMetrics:
          description: List that contains all performance and utilization measurements
            that Atlas Search index performed by the time MongoDB Atlas received this
            request.
          items:
            "$ref": "#/components/schemas/FTSMetric"
          readOnly: true
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        processId:
          description: Hostname and port that identifies the process.
          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
          type: string
        statusMetrics:
          description: List that contains all available Atlas Search status metrics
            when MongoDB Atlas received this request.
          items:
            "$ref": "#/components/schemas/FTSMetric"
          type: array
      required:
      - groupId
      - hardwareMetrics
      - indexMetrics
      - processId
      - statusMetrics
      type: object
    ClusterAlertConfigViewForNdsGroup:
      description: Cluster alert configuration allows to select which conditions of
        mongod cluster which trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroupAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/ClusterMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Cluster Alert Configuration
      type: object
    ClusterAlertViewForNdsGroup:
      description: Cluster alert notifies different activities and conditions about
        cluster of mongod hosts.
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroupAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: Cluster Alerts
      type: object
    ClusterAutoScalingSettings:
      description: Range of instance sizes to which your cluster can scale.
      externalDocs:
        description: Cluster Auto-Scaling
        url: https://docs.atlas.mongodb.com/cluster-autoscaling/
      properties:
        compute:
          "$ref": "#/components/schemas/ClusterComputeAutoScaling"
        diskGBEnabled:
          default: false
          description: Flag that indicates whether someone enabled disk auto-scaling
            for this cluster.
          type: boolean
      title: Automatic Cluster Scaling Settings
      type: object
    ClusterCloudProviderInstanceSize:
      properties:
        availableRegions:
          description: List of regions that this cloud provider supports for this
            instance size.
          items:
            "$ref": "#/components/schemas/AvailableCloudProviderRegion"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the instance size or cluster
            tier.
          readOnly: true
          type: string
      type: object
    ClusterComputeAutoScaling:
      description: Collection of settings that configures how a cluster might scale
        its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling
        is unavailable for clusters using Low CPU or NVME storage classes.
      properties:
        enabled:
          default: false
          description: |-
            Flag that indicates whether instance size reactive auto-scaling is enabled.

            - Set to `true` to enable instance size reactive auto-scaling. If enabled, you must specify a value for `providerSettings.autoScaling.compute.maxInstanceSize`.
            - Set to `false` to disable instance size reactive auto-scaling.
          type: boolean
        scaleDownEnabled:
          default: false
          description: Flag that indicates whether the cluster tier can scale down
            via reactive auto-scaling. This is required if `autoScaling.compute.enabled`
            is `true`. If you enable this option, specify a value for `providerSettings.autoScaling.compute.minInstanceSize`.
          type: boolean
      type: object
    ClusterConnectionStrings:
      description: Collection of Uniform Resource Locators that point to the MongoDB
        database.
      externalDocs:
        description: Connection string URI format.
        url: https://docs.mongodb.com/manual/reference/connection-string/
      properties:
        awsPrivateLink:
          additionalProperties:
            description: Private endpoint-aware connection strings that use AWS-hosted
              clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies
              an Amazon Web Services (AWS) interface endpoint. Each value identifies
              the related `mongodb://` connection string that you use to connect to
              MongoDB Cloud through the interface endpoint that the key names.
            externalDocs:
              description: Network Peering Connection
              url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/
            readOnly: true
            type: string
          description: Private endpoint-aware connection strings that use AWS-hosted
            clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies
            an Amazon Web Services (AWS) interface endpoint. Each value identifies
            the related `mongodb://` connection string that you use to connect to
            MongoDB Cloud through the interface endpoint that the key names.
          externalDocs:
            description: Network Peering Connection
            url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/
          readOnly: true
          type: object
        awsPrivateLinkSrv:
          additionalProperties:
            description: Private endpoint-aware connection strings that use AWS-hosted
              clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies
              an Amazon Web Services (AWS) interface endpoint. Each value identifies
              the related `mongodb://` connection string that you use to connect to
              Atlas through the interface endpoint that the key names. If the cluster
              uses an optimized connection string, `awsPrivateLinkSrv` contains the
              optimized connection string. If the cluster has the non-optimized (legacy)
              connection string, `awsPrivateLinkSrv` contains the non-optimized connection
              string even if an optimized connection string is also present.
            externalDocs:
              description: Network Peering Connection
              url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/
            readOnly: true
            type: string
          description: Private endpoint-aware connection strings that use AWS-hosted
            clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies
            an Amazon Web Services (AWS) interface endpoint. Each value identifies
            the related `mongodb://` connection string that you use to connect to
            Atlas through the interface endpoint that the key names. If the cluster
            uses an optimized connection string, `awsPrivateLinkSrv` contains the
            optimized connection string. If the cluster has the non-optimized (legacy)
            connection string, `awsPrivateLinkSrv` contains the non-optimized connection
            string even if an optimized connection string is also present.
          externalDocs:
            description: Network Peering Connection
            url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/
          readOnly: true
          type: object
        private:
          description: Network peering connection strings for each interface Virtual
            Private Cloud (VPC) endpoint that you configured to connect to this cluster.
            This connection string uses the `mongodb+srv://` protocol. The resource
            returns this parameter once someone creates a network peering connection
            to this cluster. This protocol tells the application to look up the host
            seed list in the Domain Name System (DNS). This list synchronizes with
            the nodes in a cluster. If the connection string uses this Uniform Resource
            Identifier (URI) format, you don't need to append the seed list or change
            the URI if the nodes change. Use this URI format if your driver supports
            it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services
            (AWS) clusters, this resource returns this parameter only if you enable
            custom DNS.
          externalDocs:
            description: Network Peering Connection
            url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/
          readOnly: true
          type: string
        privateEndpoint:
          description: List of private endpoint-aware connection strings that you
            can use to connect to this cluster through a private endpoint. This parameter
            returns only if you deployed a private endpoint to all regions to which
            you deployed this clusters' nodes.
          items:
            "$ref": "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint"
          readOnly: true
          type: array
        privateSrv:
          description: Network peering connection strings for each interface Virtual
            Private Cloud (VPC) endpoint that you configured to connect to this cluster.
            This connection string uses the `mongodb+srv://` protocol. The resource
            returns this parameter when someone creates a network peering connection
            to this cluster. This protocol tells the application to look up the host
            seed list in the Domain Name System (DNS). This list synchronizes with
            the nodes in a cluster. If the connection string uses this Uniform Resource
            Identifier (URI) format, you don't need to append the seed list or change
            the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform
            Resource Identifier (URI) format if your driver supports it. If it doesn't,
            use `connectionStrings.private`. For Amazon Web Services (AWS) clusters,
            this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).
          externalDocs:
            description: Network Peering Connection
            url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/
          readOnly: true
          type: string
        standard:
          description: Public connection string that you can use to connect to this
            cluster. This connection string uses the `mongodb://` protocol.
          externalDocs:
            description: Connection String URI Format
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        standardSrv:
          description: Public connection string that you can use to connect to this
            cluster. This connection string uses the `mongodb+srv://` protocol.
          externalDocs:
            description: Connection String URI Format
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
      readOnly: true
      title: Cluster Connection Strings
      type: object
    ClusterDescription20240805:
      properties:
        acceptDataRisksAndForceReplicaSetReconfig:
          description: If reconfiguration is necessary to regain a primary due to
            a regional outage, submit this field alongside your topology reconfiguration
            to request a new regional outage resistant topology. Forced reconfigurations
            during an outage of the majority of electable nodes carry a risk of data
            loss if replicated writes (even majority committed writes) have not been
            replicated to the new primary node. MongoDB Atlas docs contain more information.
            To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig`
            to the current date. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          externalDocs:
            description: Reconfiguring a Replica Set during a regional outage
            url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set
          format: date-time
          type: string
        advancedConfiguration:
          "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView"
        backupEnabled:
          default: false
          description: Flag that indicates whether the cluster can perform backups.
            If set to `true`, the cluster can perform backups. You must set this value
            to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters
            and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/)
            for tenant clusters. If set to `false`, the cluster doesn't use backups.
          externalDocs:
            description: Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        biConnector:
          "$ref": "#/components/schemas/BiConnector"
        clusterType:
          description: Configuration of nodes that comprise the cluster.
          enum:
          - REPLICASET
          - SHARDED
          - GEOSHARDED
          type: string
        configServerManagementMode:
          default: ATLAS_MANAGED
          description: Config Server Management Mode for creating or updating a sharded
            cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch
            the cluster's config server type for optimal performance and savings.
            When configured as `FIXED_TO_DEDICATED`, the cluster will always use a
            dedicated config server.
          enum:
          - ATLAS_MANAGED
          - FIXED_TO_DEDICATED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          type: string
        configServerType:
          description: Describes a sharded cluster's config server type.
          enum:
          - DEDICATED
          - EMBEDDED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          readOnly: true
          type: string
        connectionStrings:
          "$ref": "#/components/schemas/ClusterConnectionStrings"
        createDate:
          description: Date and time when MongoDB Cloud created this cluster. This
            parameter expresses its value in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        diskWarmingMode:
          default: FULLY_WARMED
          description: Disk warming mode selection.
          enum:
          - FULLY_WARMED
          - VISIBLE_EARLIER
          externalDocs:
            description: Reduce Secondary Disk Warming Impact
            url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact
          type: string
        effectiveReplicationSpecs:
          description: List of settings that represent the actual cluster state. This
            is read-only and always returned in the response. It reflects the current
            cluster configuration, which may differ from `replicationSpecs` due to
            system-managed changes.
          items:
            "$ref": "#/components/schemas/ReplicationSpec20240805"
          readOnly: true
          type: array
        encryptionAtRestProvider:
          description: 'Cloud service provider that manages your customer keys to
            provide an additional layer of encryption at rest for the cluster. To
            enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize`
            setting must be `M10` or higher and `"backupEnabled" : false` or omitted
            entirely.'
          enum:
          - NONE
          - AWS
          - AZURE
          - GCP
          externalDocs:
            description: Encryption at Rest using Customer Key Management
            url: https://www.mongodb.com/docs/atlas/security-kms-encryption/
          type: string
        featureCompatibilityVersion:
          description: Feature compatibility version of the cluster. This will always
            appear regardless of whether FCV is pinned.
          readOnly: true
          type: string
        featureCompatibilityVersionExpirationDate:
          description: Feature compatibility version expiration date. Will only appear
            if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          format: date-time
          readOnly: true
          type: string
        globalClusterSelfManagedSharding:
          description: |-
            Set this field to configure the Sharding Management Mode when creating a new Global Cluster.

            When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.

            When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.

            This setting cannot be changed once the cluster is deployed.
          externalDocs:
            description: Creating a Global Cluster
            url: https://dochub.mongodb.org/core/global-cluster-management
          type: boolean
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        internalClusterRole:
          description: 'Internal classification of the cluster''s role. Possible values:
            `NONE` (regular user cluster), `SYSTEM_CLUSTER` (system cluster for backup),
            `INTERNAL_SHADOW_CLUSTER` (internal use shadow cluster for testing).'
          enum:
          - NONE
          - SYSTEM_CLUSTER
          - INTERNAL_SHADOW_CLUSTER
          readOnly: true
          type: string
        labels:
          deprecated: true
          description: |-
            Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

            Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ComponentLabel"
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBEmployeeAccessGrant:
          "$ref": "#/components/schemas/EmployeeAccessGrantView"
        mongoDBMajorVersion:
          description: "MongoDB major version of the cluster. Set to the binary major
            version. \n\nOn creation: Choose from the available versions of MongoDB,
            or leave unspecified for the current recommended default in the MongoDB
            Cloud platform. The recommended version is a recent Long Term Support
            version. The default is not guaranteed to be the most recently released
            version throughout the entire release cycle. For versions available in
            a specific project, see the linked documentation or use the API endpoint
            for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).\n\n
            On update: Increase version only by 1 major version at a time. If the
            cluster is pinned to a MongoDB feature compatibility version exactly one
            major version below the current MongoDB version, the MongoDB version can
            be downgraded to the previous major version."
          externalDocs:
            description: Available MongoDB Versions in Atlas
            url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-
          type: string
        mongoDBVersion:
          description: Version of MongoDB that the cluster runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the cluster.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        paused:
          description: Flag that indicates whether the cluster is paused.
          type: boolean
        pitEnabled:
          description: Flag that indicates whether the cluster uses continuous cloud
            backups.
          externalDocs:
            description: Continuous Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        redactClientLogData:
          description: |-
            Enable or disable log redaction.

            This setting configures the ``mongod`` or ``mongos`` to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.

            Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.

            *Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
          externalDocs:
            description: Log Redaction
            url: https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction
          type: boolean
        replicaSetScalingStrategy:
          default: WORKLOAD_TYPE
          description: |-
            Set this field to configure the replica set scaling mode for your cluster.

            By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.

            When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.

            When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
          enum:
          - SEQUENTIAL
          - WORKLOAD_TYPE
          - NODE_TYPE
          externalDocs:
            description: Modify the Replica Set Scaling Mode
            url: https://dochub.mongodb.org/core/scale-nodes
          type: string
        replicationSpecs:
          description: List of settings that configure your cluster regions. This
            array has one object per shard representing node configurations in each
            shard. For replica sets there is only one object representing node configurations.
          items:
            "$ref": "#/components/schemas/ReplicationSpec20240805"
          type: array
        retainBackups:
          default: false
          description: Flag that indicates whether the cluster retains backups.
          type: boolean
        rootCertType:
          default: ISRGROOTX1
          description: Root Certificate Authority that MongoDB Atlas cluster uses.
            MongoDB Cloud supports Internet Security Research Group.
          enum:
          - ISRGROOTX1
          type: string
        stateName:
          description: |-
            Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

             - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
             - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
             - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
             - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
             - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the cluster.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
        useAwsTimeBasedSnapshotCopyForFastInitialSync:
          default: false
          description: Flag that indicates whether AWS time-based snapshot copies
            will be used instead of slower standard snapshot copies during fast Atlas
            cross-region initial syncs. This flag is only relevant for clusters containing
            AWS nodes.
          type: boolean
        versionReleaseSystem:
          default: LTS
          description: Method by which the cluster maintains the MongoDB versions.
            If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`.
          enum:
          - LTS
          - CONTINUOUS
          type: string
      type: object
    ClusterDescriptionAutoScalingModeConfiguration:
      description: Contains the internal configuration of AutoScaling on sharded clusters.
      properties:
        autoScalingMode:
          description: Describes whether cluster nodes scale together across all shards
            or independently.
          enum:
          - INDEPENDENT_SHARD_SCALING
          - CLUSTER_WIDE_SCALING
          type: string
      title: Internal configuration of AutoScaling on sharded clusters
      type: object
    ClusterDescriptionConnectionStringsPrivateEndpoint:
      description: Private endpoint-aware connection string that you can use to connect
        to this cluster through a private endpoint.
      externalDocs:
        description: Private Endpoint for Dedicated Cluster
        url: https://docs.atlas.mongodb.com/security-private-endpoint/
      properties:
        connectionString:
          description: Private endpoint-aware connection string that uses the `mongodb://`
            protocol to connect to MongoDB Cloud through a private endpoint.
          readOnly: true
          type: string
        endpoints:
          description: List that contains the private endpoints through which you
            connect to MongoDB Cloud when you use `connectionStrings.privateEndpoint[n].connectionString`
            or `connectionStrings.privateEndpoint[n].srvConnectionString`.
          items:
            "$ref": "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint"
          readOnly: true
          type: array
        srvConnectionString:
          description: Private endpoint-aware connection string that uses the `mongodb+srv://`
            protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv`
            protocol tells the driver to look up the seed list of hosts in the Domain
            Name System (DNS). This list synchronizes with the nodes in a cluster.
            If the connection string uses this Uniform Resource Identifier (URI) format,
            you don't need to append the seed list or change the Uniform Resource
            Identifier (URI) if the nodes change. Use this Uniform Resource Identifier
            (URI) format if your application supports it. If it doesn't, use `connectionStrings.privateEndpoint[n].connectionString`.
          readOnly: true
          type: string
        srvShardOptimizedConnectionString:
          description: Private endpoint-aware connection string optimized for sharded
            clusters that uses the `mongodb+srv://` protocol to connect to MongoDB
            Cloud through a private endpoint. If the connection string uses this Uniform
            Resource Identifier (URI) format, you don't need to change the Uniform
            Resource Identifier (URI) if the nodes change. Use this Uniform Resource
            Identifier (URI) format if your application and Atlas cluster supports
            it. If it doesn't, use and consult the documentation for `connectionStrings.privateEndpoint[n].srvConnectionString`.
          readOnly: true
          type: string
        type:
          description: MongoDB process type to which your application connects. Use
            `MONGOD` for replica sets and `MONGOS` for sharded clusters.
          enum:
          - MONGOD
          - MONGOS
          readOnly: true
          type: string
      title: Cluster Private Endpoint Connection String
      type: object
    ClusterDescriptionConnectionStringsPrivateEndpointEndpoint:
      description: Details of a private endpoint deployed for this cluster.
      properties:
        endpointId:
          description: Unique string that the cloud provider uses to identify the
            private endpoint.
          readOnly: true
          type: string
        providerName:
          description: Cloud provider in which MongoDB Cloud deploys the private endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        region:
          description: Region where the private endpoint is deployed.
          readOnly: true
          type: string
      title: Cluster Private Endpoint Connection Strings Endpoint
      type: object
    ClusterDescriptionProcessArgs20240805:
      properties:
        changeStreamOptionsPreAndPostImagesExpireAfterSeconds:
          default: -1
          description: The minimum pre- and post-image retention time in seconds.
          externalDocs:
            description: 'This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``
              cluster parameter. This setting controls the retention policy of change
              stream pre- and post-images. Pre- and post-images are the versions of
              a document before and after document modification, respectively. ``expireAfterSeconds``
              controls how long MongoDB retains pre- and post-images. When set to
              -1 (off), MongoDB uses the default retention policy: pre- and post-images
              are retained until the corresponding change stream events are removed
              from the oplog. To set the minimum pre- and post-image retention time,
              specify an integer value greater than zero. Setting this too low could
              increase the risk of interrupting Realm sync or triggers processing.
              The default value is -1 (off).'
            url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds
          format: int32
          type: integer
        chunkMigrationConcurrency:
          description: Number of threads on the source shard and the receiving shard
            for chunk migration. The number of threads should not exceed the half
            the total number of CPU cores in the sharded cluster.
          externalDocs:
            description: This option corresponds to the `chunkMigrationConcurrency`
              `mongod` configuration file option.
            url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency
          format: int32
          type: integer
        customOpensslCipherConfigTls12:
          description: The custom OpenSSL cipher suite list for TLS 1.2. This field
            is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
          externalDocs:
            description: This option corresponds to the `opensslCipherConfig` `mongod`
              configuration file option.
            url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherConfig
          items:
            enum:
            - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
            - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
            type: string
          type: array
        customOpensslCipherConfigTls13:
          description: The custom OpenSSL cipher suite list for TLS 1.3. This field
            is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
          externalDocs:
            description: This option corresponds to the `opensslCipherSuiteConfig`
              `mongod` configuration file option.
            url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.opensslCipherSuiteConfig
          items:
            enum:
            - TLS_AES_256_GCM_SHA384
            - TLS_CHACHA20_POLY1305_SHA256
            - TLS_AES_128_GCM_SHA256
            - TLS_AES_128_CCM_SHA256
            type: string
          maxItems: 4
          type: array
        defaultMaxTimeMS:
          description: Default time limit in milliseconds for individual read operations
            to complete.
          externalDocs:
            description: This option corresponds to the `defaultMaxTimeMS` cluster
              parameter.
            url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/
          format: int32
          type: integer
        defaultWriteConcern:
          description: Default level of acknowledgment requested from MongoDB for
            write operations when none is specified by the driver.
          externalDocs:
            description: This option corresponds to the the implicit default write
              concern.
            url: https://docs.mongodb.com/manual/reference/write-concern/
          type: string
        javascriptEnabled:
          description: Flag that indicates whether the cluster allows execution of
            operations that perform server-side executions of JavaScript. When using
            8.0+, we recommend disabling server-side JavaScript and using operators
            of aggregation pipeline as more performant alternative.
          externalDocs:
            description: This option corresponds to modifying the `security.javascriptEnabled`
              configuration file option for each `mongod` and `mongos` in the cluster.
            url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled
          type: boolean
        minimumEnabledTlsProtocol:
          description: Minimum Transport Layer Security (TLS) version that the cluster
            accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should
            consider setting TLS 1.2 as the minimum TLS protocol version.
          enum:
          - TLS1_0
          - TLS1_1
          - TLS1_2
          - TLS1_3
          externalDocs:
            description: This option corresponds to the `net.ssl.disabledProtocols`
              `mongod` configuration file option.
            url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols
          type: string
        noTableScan:
          description: Flag that indicates whether the cluster disables executing
            any query that requires a collection scan to return results.
          externalDocs:
            description: This option corresponds to the `notablescan` `mongod` configuration
              file option.
            url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan
          type: boolean
        oplogMinRetentionHours:
          description: Minimum retention window for cluster's oplog expressed in hours.
            A value of null indicates that the cluster uses the default minimum oplog
            window that MongoDB Cloud calculates.
          externalDocs:
            description: This option corresponds to the `storage.oplogMinRetentionHours`
              `mongod` configuration file option.
            url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours
          format: double
          nullable: true
          type: number
        oplogSizeMB:
          description: Storage limit of cluster's oplog expressed in megabytes. A
            value of null indicates that the cluster uses the default oplog size that
            MongoDB Cloud calculates.
          externalDocs:
            description: This option corresponds to the `replication.oplogSizeMB`
              `mongod` configuration file option.
            url: https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB
          format: int32
          nullable: true
          type: integer
        queryStatsLogVerbosity:
          description: May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas
            will include redacted and anonymized `$queryStats` output in MongoDB logs.
            `$queryStats` output does not contain literals or field values. Enabling
            this setting might impact the performance of your cluster.
          externalDocs:
            description: This option corresponds to the `queryStats` component for
              the `logComponentVerbosity` server parameter.
            url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity
          format: int32
          type: integer
        sampleRefreshIntervalBIConnector:
          default: 0
          description: Interval in seconds at which the mongosqld process re-samples
            data to create its relational schema.
          externalDocs:
            description: This option corresponds to the `sampleRefreshIntervalSecs`
              `mongosqld` option.
            url: https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs
          format: int32
          minimum: 0
          type: integer
        sampleSizeBIConnector:
          description: Number of documents per database to sample when gathering schema
            information.
          externalDocs:
            description: This option corresponds to the `sampleSize` `mongosqld` option.
            url: https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize
          format: int32
          minimum: 0
          type: integer
        tlsCipherConfigMode:
          description: The TLS cipher suite configuration mode. The default mode uses
            the default cipher suites. The custom mode allows you to specify custom
            cipher suites for both TLS 1.2 and TLS 1.3.
          enum:
          - CUSTOM
          - DEFAULT
          type: string
        transactionLifetimeLimitSeconds:
          description: Lifetime, in seconds, of multi-document transactions. Atlas
            considers the transactions that exceed this limit as expired and so aborts
            them through a periodic clean-up process.
          externalDocs:
            description: This option corresponds to the `transactionLifetimeLimitSeconds`
              `mongod` configuration file option.
            url: https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds
          format: int64
          minimum: 1
          type: integer
      type: object
    ClusterEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - CLUSTER_MONGOS_IS_PRESENT
      - CLUSTER_MONGOS_IS_MISSING
      example: CLUSTER_MONGOS_IS_PRESENT
      title: Cluster Event Types
      type: string
    ClusterEventTypeViewForNdsGroupAlertable:
      description: Event type that triggers an alert.
      enum:
      - CLUSTER_MONGOS_IS_MISSING
      example: CLUSTER_MONGOS_IS_MISSING
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Cluster Event Types
      type: string
    ClusterEventViewForNdsGroup:
      description: Cluster event identifies different activities about cluster of
        mongod hosts.
      properties:
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Cluster Events
      type: object
    ClusterFlexProviderSettings:
      allOf:
      - "$ref": "#/components/schemas/ClusterProviderSettings"
      - properties:
          backingProviderName:
            description: Cloud service provider on which MongoDB Cloud provisioned
              the multi-tenant host. The resource returns this parameter when `providerSettings.providerName`
              is `FLEX` and `providerSetting.instanceSizeName` is `FLEX`.
            enum:
            - AWS
            - GCP
            - AZURE
            type: string
          instanceSizeName:
            description: Cluster tier, with a default storage and memory capacity,
              that applies to all the data-bearing hosts in your cluster. You must
              set `providerSettings.providerName` to `FLEX` and specify the cloud
              service provider in `providerSettings.backingProviderName`.
            enum:
            - FLEX
            title: Flex Instance Sizes
            type: string
          regionName:
            description: Human-readable label that identifies the geographic location
              of your MongoDB cluster. The region you choose can affect network latency
              for clients accessing your databases. For a complete list of region
              names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
              [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
            type: string
        type: object
      type: object
    ClusterFreeAutoScaling:
      description: Range of instance sizes to which your cluster can scale.
      properties:
        compute:
          "$ref": "#/components/schemas/FreeComputeAutoScalingRules"
      type: object
    ClusterFreeProviderSettings:
      allOf:
      - "$ref": "#/components/schemas/ClusterProviderSettings"
      - properties:
          autoScaling:
            "$ref": "#/components/schemas/ClusterFreeAutoScaling"
          backingProviderName:
            description: "Cloud service provider on which MongoDB Cloud provisioned
              the multi-tenant host. The resource returns this parameter when `providerSettings.providerName`
              is `TENANT` and `providerSetting.instanceSizeName` is `M0`, `M2` or
              `M5`. \n\nPlease note that using an `instanceSize` of M2 or M5 will
              create a Flex cluster instead. Support for the `instanceSize` of M2
              or M5 will be discontinued in January 2026. We recommend using the Create
              Flex Cluster API for such configurations moving forward."
            enum:
            - AWS
            - GCP
            - AZURE
            externalDocs:
              description: Create Flex Cluster API
              url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
            type: string
          effectiveInstanceSizeName:
            description: The true tenant instance size. This is present to support
              backwards compatibility for deprecated provider types and/or instance
              sizes.
            enum:
            - FLEX
            - M2
            - M5
            - M0
            readOnly: true
            type: string
          instanceSizeName:
            description: Cluster tier, with a default storage and memory capacity,
              that applies to all the data-bearing hosts in your cluster. You must
              set `providerSettings.providerName` to `TENANT` and specify the cloud
              service provider in `providerSettings.backingProviderName`.
            enum:
            - M0
            - M2
            - M5
            title: Tenant Instance Sizes
            type: string
          regionName:
            description: Human-readable label that identifies the geographic location
              of your MongoDB cluster. The region you choose can affect network latency
              for clients accessing your databases. For a complete list of region
              names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
              [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
              For multi-region clusters, see `replicationSpec.{region}`.
            type: string
        type: object
      type: object
    ClusterIPAddresses:
      description: List of IP addresses in a cluster.
      properties:
        clusterName:
          description: Human-readable label that identifies the cluster.
          readOnly: true
          type: string
        futureInbound:
          description: List of future inbound IP addresses associated with the cluster.
            If your network allows outbound HTTP requests only to specific IP addresses,
            you must allow access to the following IP addresses so that your application
            can connect to your Atlas cluster.
          items:
            type: string
          readOnly: true
          type: array
        futureOutbound:
          description: List of future outbound IP addresses associated with the cluster.
            If your network allows inbound HTTP requests only from specific IP addresses,
            you must allow access from the following IP addresses so that your Atlas
            cluster can communicate with your webhooks and KMS.
          items:
            type: string
          readOnly: true
          type: array
        inbound:
          description: List of inbound IP addresses associated with the cluster. If
            your network allows outbound HTTP requests only to specific IP addresses,
            you must allow access to the following IP addresses so that your application
            can connect to your Atlas cluster.
          items:
            type: string
          readOnly: true
          type: array
        outbound:
          description: List of outbound IP addresses associated with the cluster.
            If your network allows inbound HTTP requests only from specific IP addresses,
            you must allow access from the following IP addresses so that your Atlas
            cluster can communicate with your webhooks and KMS.
          items:
            type: string
          readOnly: true
          type: array
      title: Cluster IP Addresses
      type: object
    ClusterMatcher:
      description: Rules to apply when comparing an cluster against this alert configuration.
      properties:
        fieldName:
          "$ref": "#/components/schemas/ClusterMatcherField"
        operator:
          description: Comparison operator to apply when checking the current metric
            value against **matcher[n].value**. The `REGEX` operator only supports
            inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
          type: string
        value:
          description: Value to match or exceed using the specified `matchers.operator`.
          example: event-replica-set
          type: string
      required:
      - fieldName
      - operator
      - value
      title: Matchers
      type: object
    ClusterMatcherField:
      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:
      - CLUSTER_NAME
      example: CLUSTER_NAME
      title: Cluster Matcher Fields
      type: string
    ClusterOutageSimulation:
      properties:
        clusterName:
          description: Human-readable label that identifies the cluster that undergoes
            outage simulation.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        expirationDate:
          description: Date and time when MongoDB Cloud expires the outage simulation.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. If not provided, defaults to 3 days from the start date.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project that contains the cluster to undergo outage simulation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            outage simulation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        outageFilters:
          description: List of settings that specify the type of cluster outage simulation.
          items:
            "$ref": "#/components/schemas/AtlasClusterOutageSimulationOutageFilter"
          minItems: 1
          type: array
        startRequestDate:
          description: Date and time when MongoDB Cloud started the regional outage
            simulation. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          format: date-time
          readOnly: true
          type: string
        state:
          description: |-
            Phase of the outage simulation.

            | State       | Indication |
            |-------------|------------|
            | `START_REQUESTED`    | User has requested cluster outage simulation.|
            | `STARTING`           | MongoDB Cloud is starting cluster outage simulation.|
            | `SIMULATING`         | MongoDB Cloud is simulating cluster outage.|
            | `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|
            | `RECOVERING`         | MongoDB Cloud is recovering the cluster from the simulated outage.|
            | `COMPLETE`           | MongoDB Cloud has completed the cluster outage simulation.|
          enum:
          - START_REQUESTED
          - STARTING
          - SIMULATING
          - RECOVERY_REQUESTED
          - RECOVERING
          - COMPLETE
          readOnly: true
          type: string
      type: object
    ClusterProviderSettings:
      description: Group of cloud provider settings that configure the provisioned
        MongoDB hosts.
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSCloudProviderSettings"
          AZURE: "#/components/schemas/AzureCloudProviderSettings"
          FLEX: "#/components/schemas/ClusterFlexProviderSettings"
          GCP: "#/components/schemas/CloudGCPProviderSettings"
          TENANT: "#/components/schemas/ClusterFreeProviderSettings"
        propertyName: providerName
      oneOf:
      - "$ref": "#/components/schemas/AWSCloudProviderSettings"
      - "$ref": "#/components/schemas/AzureCloudProviderSettings"
      - "$ref": "#/components/schemas/CloudGCPProviderSettings"
      - "$ref": "#/components/schemas/ClusterFreeProviderSettings"
      - "$ref": "#/components/schemas/ClusterFlexProviderSettings"
      properties:
        providerName:
          type: string
      required:
      - providerName
      title: Cloud Service Provider Settings for a Cluster
      type: object
    ClusterSearchIndex:
      discriminator:
        mapping:
          search: "#/components/schemas/SearchIndex"
          vectorSearch: "#/components/schemas/VectorSearchIndex"
        propertyName: type
      properties:
        collectionName:
          description: Human-readable label that identifies the collection that contains
            one or more Atlas Search indexes.
          type: string
        database:
          description: Human-readable label that identifies the database that contains
            the collection with one or more Atlas Search indexes.
          type: string
        indexID:
          description: Unique 24-hexadecimal digit string that identifies this Atlas
            Search index.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies this index. Within each
            namespace, names of all indexes in the namespace must be unique.
          type: string
        numPartitions:
          default: 1
          description: Number of index partitions. Allowed values are [1, 2, 4].
          format: int32
          type: integer
        status:
          description: |-
            Condition of the search index when you made this request.

            - `IN_PROGRESS`: Atlas is building or re-building the index after an edit.
            - `STEADY`: You can use this search index.
            - `FAILED`: Atlas could not build the index.
            - `MIGRATING`: Atlas is upgrading the underlying cluster tier and migrating indexes.
            - `PAUSED`: The cluster is paused.
          enum:
          - IN_PROGRESS
          - STEADY
          - FAILED
          - MIGRATING
          - STALE
          - PAUSED
          readOnly: true
          type: string
        storedSource:
          description: Flag that indicates whether to store all fields (true) on Atlas
            Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively,
            you can specify an object that only contains the list of fields to store
            (include) or not store (exclude) on Atlas Search. Note that storing all
            fields (true) is not allowed for vector search indexes. To learn more,
            see documentation.
          example:
            include | exclude:
            - field1
            - field2
          externalDocs:
            description: Stored Source Fields
            url: https://dochub.mongodb.org/core/atlas-search-stored-source
          type: object
        type:
          description: Type of the index. Default type is search.
          enum:
          - search
          - vectorSearch
          type: string
      required:
      - collectionName
      - database
      - name
      type: object
    ClusterServerlessBackupOptions:
      description: Group of settings that configure serverless backup.
      properties:
        serverlessContinuousBackupEnabled:
          default: true
          description: |-
            Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.
             If this parameter is `false`, the serverless instance uses **Basic Backup**.

             | Option | Description |
             |---|---|
             | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |
             | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |
          type: boolean
      title: Serverless Backup Options
      type: object
    ClusterStatus:
      properties:
        changeStatus:
          description: State of cluster at the time of this request. Atlas returns
            **Applied** if it completed adding a user to, or removing a user from,
            your cluster. Atlas returns **Pending** if it's still making the requested
            user changes. When status is **Pending**, new users can't log in.
          enum:
          - PENDING
          - APPLIED
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    CollStatsRankedNamespacesView:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the request
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        identifierId:
          description: Unique 24-hexadecimal digit string that identifies the request
            process.
          readOnly: true
          type: string
        rankedNamespaces:
          description: Ordered list of the hottest namespaces, highest value first.
          items:
            description: A single namespace.
            readOnly: true
            type: string
          readOnly: true
          type: array
      required:
      - rankedNamespaces
      type: object
    Collation:
      description: One or more settings that specify language-specific rules to compare
        strings within this index.
      externalDocs:
        description: Collation Options
        url: https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options
      properties:
        alternate:
          default: non-ignorable
          description: Method to handle whitespace and punctuation as base characters
            for purposes of comparison. `"non-ignorable"` will evaluate Whitespace
            and Punctuation as Base Characters. `"shifted"` will not, MongoDB Cloud
            distinguishes these characters when `"strength" > 3`.
          enum:
          - non-ignorable
          - shifted
          type: string
        backwards:
          default: false
          description: Flag that indicates whether strings with diacritics sort from
            back of the string. Some French dictionary orders strings in this way.
            `true` will compare from back to front. `false` will compare from front
            to back.
          type: boolean
        caseFirst:
          default: 'off'
          description: Method to handle sort order of case differences during tertiary
            level comparisons. `"upper"` sorts Uppercase before lowercase. `"lower"`
            sorts Lowercase before uppercase. `"off"` is similar to "lower" with slight
            differences.
          enum:
          - lower
          - 'off'
          - upper
          type: string
        caseLevel:
          default: false
          description: |-
            Flag that indicates whether to include case comparison when `"strength" : 1` or `"strength" : 2`.
            - `true` - Include casing in comparison
              - Strength Level: 1 - Base characters and case.
              - Strength Level: 2 - Base characters, diacritics (and possible other secondary differences),   and case.
            - `false` - Case is NOT included in comparison.
          type: boolean
        locale:
          description: 'International Components for Unicode (ICU) code that represents
            a localized language. To specify simple binary comparison, set `"locale"
            : "simple"`.'
          enum:
          - af
          - sq
          - am
          - ar
          - hy
          - as
          - az
          - bn
          - be
          - bs
          - bs_Cyrl
          - bg
          - my
          - ca
          - chr
          - zh
          - zh_Hant
          - hr
          - cs
          - da
          - nl
          - dz
          - en
          - en_US
          - en_US_POSIX
          - eo
          - et
          - ee
          - fo
          - fil
          - fi_FI
          - fr
          - fr_CA
          - gl
          - ka
          - de
          - de_AT
          - el
          - gu
          - ha
          - haw
          - he
          - hi
          - hu
          - is
          - ig
          - smn
          - id
          - ga
          - it
          - ja
          - kl
          - kn
          - kk
          - km
          - kok
          - ko
          - ky
          - lk
          - lo
          - lv
          - li
          - lt
          - dsb
          - lb
          - mk
          - ms
          - ml
          - mt
          - mr
          - mn
          - ne
          - se
          - nb
          - nn
          - or
          - om
          - ps
          - fa
          - fa_AF
          - pl
          - pt
          - pa
          - ro
          - ru
          - sr
          - sr_Latn
          - si
          - sk
          - sl
          - es
          - sw
          - sv
          - ta
          - te
          - th
          - bo
          - to
          - tr
          - uk
          - hsb
          - ur
          - ug
          - vi
          - wae
          - cy
          - yi
          - yo
          - zu
          - simple
          type: string
        maxVariable:
          description: 'Field that indicates which characters can be ignored when
            `"alternate" : "shifted"`.`"punct"` ignores both whitespace and punctuation.
            `"space"` ignores whitespace. This has no affect if `"alternate" : "non-ignorable"`.'
          enum:
          - punct
          - space
          type: string
        normalization:
          default: false
          description: |-
            Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.

            `true` will check if fully normalized and perform normalization to compare text. `false` will not check.
          type: boolean
        numericOrdering:
          default: false
          description: Flag that indicates whether to compare sequences of digits
            as numbers or as strings. `true` will compare as numbers, this results
            in `10 > 2`. `false` will Compare as strings. This results in `"10" <
            "2"`.
          type: boolean
        strength:
          default: 3
          description: |-
            Degree of comparison to perform when sorting words.

            MongoDB Cloud accepts the following _numeric values_ that correspond to the _comparison level_ and what that _comparison method_ is.

            - `1` - "Primary" - Compares the base characters only, ignoring other differences such as diacritics and case.
            - `2` - "Secondary" - Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences.
            - `3` - "Tertiary" - Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences.
            - `4` - "Quaternary" - Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text.
            - `5` - "Identical" - Compares for the specific use case of tie breaker.
          format: int32
          maximum: 5
          minimum: 1
          type: integer
      required:
      - locale
      type: object
      writeOnly: true
    ComponentLabel:
      description: Human-readable labels applied to this MongoDB Cloud component.
      properties:
        key:
          description: Key applied to tag and categorize this component.
          maxLength: 255
          minLength: 1
          type: string
        value:
          description: Value set to the Key applied to tag and categorize this component.
          maxLength: 255
          minLength: 1
          type: string
      title: Component Label
      type: object
    ComputedMemoryDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    ConfluentSaslInheritAuthentication:
      allOf:
      - "$ref": "#/components/schemas/SchemaRegistryAuthentication"
      description: Inherits the authentication configuration from Kafka for the Confluent
        Schema Registry.
      required:
      - type
      type: object
    ConfluentUserInfoAuthentication:
      allOf:
      - "$ref": "#/components/schemas/SchemaRegistryAuthentication"
      - properties:
          password:
            description: Password or Private Key for authentication.
            type: string
            writeOnly: true
          username:
            description: Username or Public Key for authentication.
            type: string
        type: object
      description: Authentication details for type `USER_INFO` with username and password
        for Confluent Schema Registry.
      required:
      - password
      - type
      - username
      type: object
    ConnectedOrgConfig:
      properties:
        dataAccessIdentityProviderIds:
          description: The collection of unique ids representing the identity providers
            that can be used for data access in this organization.
          items:
            description: Unique 24-hexadecimal digit string that represents the id
              of the identity providers that can be used for data access in this organization.
            type: string
          type: array
          uniqueItems: true
        domainAllowList:
          description: Approved domains that restrict users who can join the organization
            based on their email address.
          items:
            type: string
          type: array
          uniqueItems: true
        domainRestrictionEnabled:
          description: Value that indicates whether domain restriction is enabled
            for this connected organization.
          type: boolean
        identityProviderId:
          description: Legacy 20-hexadecimal digit string that identifies the UI access
            identity provider that this connected organization configuration is associated
            with. 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.
          pattern: "^([a-f0-9]{20})$"
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the connected
            organization configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        postAuthRoleGrants:
          description: Atlas roles that are granted to a user in this organization
            after authenticating. Roles are a human-readable label that identifies
            the collection of privileges that MongoDB Cloud grants a specific MongoDB
            Cloud user. These roles can only be organization specific roles.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          type: array
          uniqueItems: true
        roleMappings:
          description: Role mappings that are configured in this organization.
          items:
            "$ref": "#/components/schemas/AuthFederationRoleMapping"
          type: array
          uniqueItems: true
        userConflicts:
          description: List that contains the users who have an email address that
            doesn't match any domain on the allowed list.
          items:
            "$ref": "#/components/schemas/FederatedUser"
          type: array
      required:
      - domainRestrictionEnabled
      - orgId
      type: object
    ConnectedOrgConfigRoleAssignment:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to which this role belongs. Each element within `roleAssignments` can
            have a value for `groupId` or `orgId`, but not both.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which this role belongs. Each element within `roleAssignments` can
            have a value for `orgId` or `groupId`, but not both.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        role:
          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.
          externalDocs:
            description: MongoDB Atlas User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          type: string
      type: object
    ConnectionsMaxRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ConnectionsPercentRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ConnectionsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ControlPlaneIPAddresses:
      description: List of IP addresses in the Atlas control plane.
      properties:
        inbound:
          "$ref": "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses"
        outbound:
          "$ref": "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses"
      title: Control Plane IP Addresses
      type: object
    CostExplorerFilterRequestBody:
      description: Request body for a cost explorer query.
      properties:
        clusters:
          description: The list of clusters to be included in the Cost Explorer Query.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          type: array
        endDate:
          description: The exclusive ending date for the Cost Explorer query. The
            date must be the start of a month.
          format: date
          type: string
        groupBy:
          description: The dimension to group the returned usage results by. At least
            one filter value needs to be provided for a dimension to be used.
          enum:
          - organizations
          - projects
          - clusters
          - services
          type: string
        includePartialMatches:
          description: Flag to control whether usage that matches the filter criteria,
            but does not have values for all filter criteria is included in response.
            Default is false, which excludes the partially matching data.
          type: boolean
        organizations:
          description: The list of organizations to be included in the Cost Explorer
            Query.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          type: array
        projects:
          description: The list of projects to be included in the Cost Explorer Query.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          type: array
        services:
          description: The list of SKU services to be included in the Cost Explorer
            Query.
          items:
            enum:
            - Atlas
            - Clusters
            - Storage
            - Serverless Instances
            - Backup
            - Data Transfer
            - BI Connector
            - DSC Compute
            - DSC Storage
            - Premium Features
            - Atlas Data Federation
            - Atlas Stream Processing
            - App Services
            - Charts
            - Cloud Manager
            - Cloud Manager Standard/Premium
            - Legacy Backup
            - AI Models
            - Automated Embedding
            - Native Reranking
            - Flex Consulting
            - Support
            - Credits
            type: string
          type: array
        startDate:
          description: The inclusive starting date for the Cost Explorer query. The
            date must be the start of a month.
          format: date
          type: string
      required:
      - endDate
      - startDate
      type: object
    CostExplorerFilterResponseView:
      description: Response object to give information about created query.
      properties:
        token:
          description: The token used to identify the created Cost Explorer query.
          example: d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71
          maxLength: 64
          minLength: 64
          type: string
      type: object
    CostExplorerQueryResult:
      type: object
    CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold:
      description: Event type that triggers an alert.
      enum:
      - CPS_SNAPSHOT_BEHIND
      - CPS_PREV_SNAPSHOT_OLD
      - CPS_OPLOG_BEHIND
      example: CPS_SNAPSHOT_BEHIND
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Cps Backup Event Type
      type: string
    CpsBackupThresholdAlertConfigViewForNdsGroup:
      description: Cps Backup threshold alert configuration allows to select thresholds
        for conditions of CPS backup or oplogs anomalies which trigger alerts and
        how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/GreaterThanTimeThreshold"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Cps Backup Threshold Alert Configuration
      type: object
    CreateAWSEndpointRequest:
      allOf:
      - "$ref": "#/components/schemas/CreateEndpointRequest"
      - properties:
          id:
            description: Unique string that identifies the private endpoint's network
              interface that someone added to this private endpoint service.
            example: vpce-3bf78b0ddee411ba1
            pattern: "^vpce-[0-9a-f]{17}$"
            type: string
            writeOnly: true
        type: object
      description: Group of Private Endpoint settings.
      required:
      - id
      title: AWS
      type: object
    CreateAtlasOrganizationApiKey:
      description: Organization Service Account that Atlas creates for this organization.
        If omitted, Atlas doesn't create an organization Service Account for this
        organization. If specified, this object requires all body parameters. Note
        that API Keys cannot be specified in the same request.
      properties:
        desc:
          description: Purpose or explanation provided when someone created this organization
            API key.
          maxLength: 250
          minLength: 1
          type: string
        roles:
          description: List of roles to grant this API key. If you provide this list,
            provide a minimum of one role and ensure each role applies to this organization.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          minItems: 1
          type: array
      required:
      - desc
      - roles
      type: object
    CreateAtlasProjectApiKey:
      properties:
        desc:
          description: Purpose or explanation provided when someone created this project
            API key.
          maxLength: 250
          minLength: 1
          type: string
        roles:
          description: List of roles to grant this API key. If you provide this list,
            provide a minimum of one role and ensure each role applies to this project.
          externalDocs:
            description: MongoDB Cloud API Key Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          minItems: 1
          type: array
      required:
      - desc
      - roles
      type: object
    CreateAzureEndpointRequest:
      allOf:
      - "$ref": "#/components/schemas/CreateEndpointRequest"
      - properties:
          id:
            description: Unique string that identifies the 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"
            type: string
            writeOnly: true
          privateEndpointIPAddress:
            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}$"
            type: string
        type: object
      description: Group of Private Endpoint settings.
      required:
      - id
      - privateEndpointIPAddress
      title: AZURE
      type: object
    CreateDataProcessRegionView:
      description: Settings to configure the region where you wish to store your archived
        data.
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSCreateDataProcessRegionView"
          AZURE: "#/components/schemas/AzureCreateDataProcessRegionView"
          GCP: "#/components/schemas/GCPCreateDataProcessRegionView"
        propertyName: cloudProvider
      properties:
        cloudProvider:
          description: Human-readable label that identifies the Cloud service provider
            where you wish to store your archived data. `AZURE` or `GCP` may be selected
            only if it is the Cloud service provider for the cluster and no archives
            for any other cloud provider have been created for the cluster.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      type: object
      writeOnly: true
    CreateEndpointRequest:
      oneOf:
      - "$ref": "#/components/schemas/CreateAWSEndpointRequest"
      - "$ref": "#/components/schemas/CreateAzureEndpointRequest"
      - "$ref": "#/components/schemas/CreateGCPEndpointGroupRequest"
      type: object
    CreateGCPEndpointGroupRequest:
      allOf:
      - "$ref": "#/components/schemas/CreateEndpointRequest"
      - properties:
          endpointGroupName:
            description: Human-readable label that identifies a set of endpoints.
              If this private endpoint belongs to a port-mapped endpoint service,
              this field is still required but ignored.
            type: string
            writeOnly: true
          endpoints:
            description: List of individual private endpoints that comprise this endpoint
              group. If this endpoint belongs to a port-mapped endpoint service, this
              field will only take in a list of one private endpoint.
            externalDocs:
              description: Google Cloud Forwarding Rule Concepts
              url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts
            items:
              "$ref": "#/components/schemas/CreateGCPForwardingRuleRequest"
            type: array
          gcpProjectId:
            description: Unique string that identifies the Google Cloud project in
              which you created the endpoints.
            example: p-fdeeb3e43b8e733e5ab627b1
            externalDocs:
              description: Google Cloud Creating and Managing Projects
              url: https://cloud.google.com/resource-manager/docs/creating-managing-projects
            pattern: "^p-[0-9a-z]{24}$"
            type: string
            writeOnly: true
        type: object
      description: Group of Private Endpoint settings.
      required:
      - endpointGroupName
      - gcpProjectId
      title: GCP
      type: object
    CreateGCPForwardingRuleRequest:
      properties:
        endpointName:
          description: Human-readable label that identifies the Google Cloud consumer
            forwarding rule that you created.
          externalDocs:
            description: Google Cloud Forwarding Rule Concepts
            url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts
          type: string
          writeOnly: true
        ipAddress:
          description: One Private Internet Protocol version 4 (IPv4) address to which
            this Google Cloud consumer forwarding rule resolves.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
          writeOnly: true
      title: GCP Forwarding Rules
      type: object
    CreateOrganizationRequest:
      properties:
        apiKey:
          "$ref": "#/components/schemas/CreateAtlasOrganizationApiKey"
        federationSettingsId:
          description: Unique 24-hexadecimal digit string that identifies the federation
            to link the newly created organization to. If specified, the proposed
            Organization Owner of the new organization must have the Organization
            Owner role in an organization associated with the federation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        name:
          description: Human-readable label that identifies the organization.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
        orgOwnerId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user that you want to assign the Organization Owner role. This user
            must be a member of the same organization as the calling API key. If you
            provide `federationSettingsId`,  this user must instead have the Organization
            Owner role on an organization in the specified federation. This parameter
            is required only when you authenticate with Programmatic API Keys.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        serviceAccount:
          "$ref": "#/components/schemas/OrgServiceAccountRequest"
        skipDefaultAlertsSettings:
          default: false
          description: Disables automatic alert creation. When set to true, no organization
            level alerts will be created automatically.
          type: boolean
      required:
      - name
      type: object
    CreateOrganizationResponse:
      properties:
        apiKey:
          "$ref": "#/components/schemas/ApiKeyUserDetails"
        federationSettingsId:
          description: Unique 24-hexadecimal digit string that identifies the federation
            that you linked the newly created organization to.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        orgOwnerId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user that you assigned the Organization Owner role in the new organization.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        organization:
          "$ref": "#/components/schemas/AtlasOrganization"
        serviceAccount:
          "$ref": "#/components/schemas/OrgServiceAccount"
        skipDefaultAlertsSettings:
          default: false
          description: Disables automatic alert creation. When set to true, no organization
            level alerts will be created automatically.
          type: boolean
      type: object
    CreatePushBasedLogExportProjectRequest:
      properties:
        bucketName:
          description: The name of the bucket to which the agent will send the logs
            to.
          type: string
        iamRoleId:
          description: ID of the AWS IAM role that will be used to write to the S3
            bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        prefixPath:
          description: S3 directory in which vector will write to in order to store
            the logs. An empty string denotes the root directory.
          type: string
      required:
      - bucketName
      - iamRoleId
      - prefixPath
      type: object
    CriteriaView:
      description: |-
        Rules by which MongoDB Cloud archives data.

        Use the `criteria.type` field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.
        `"criteria.type": "DATE"` selects documents to archive based on a date.
        `"criteria.type": "CUSTOM"` selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support `"criteria.type": "CUSTOM"` when `"collectionType": "TIMESERIES"`.
      discriminator:
        mapping:
          CUSTOM: "#/components/schemas/CustomCriteriaView"
          DATE: "#/components/schemas/DateCriteriaView"
        propertyName: type
      properties:
        type:
          description: |-
            Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.
            `DATE` selects documents to archive based on a date.
            `CUSTOM` selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support `CUSTOM` when `"collectionType": "TIMESERIES"`.
          enum:
          - DATE
          - CUSTOM
          type: string
      type: object
    CursorsTotalClientCursorsSizeRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    CursorsTotalOpenRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    CursorsTotalTimedOutRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    CustomCriteriaView:
      allOf:
      - "$ref": "#/components/schemas/CriteriaView"
      - properties:
          query:
            description: 'MongoDB find query that selects documents to archive. The
              specified query follows the syntax of the `db.collection.find(query)`
              command. This query can''t use the empty document (`{}`) to return all
              documents. Set this parameter when `"criteria.type" : "CUSTOM"`.'
            type: string
        type: object
      description: Custom archival criteria.
      required:
      - query
      title: Archival Criteria
      type: object
    CustomSessionTimeouts:
      description: Defines the session timeout settings for managing user sessions
        at the organization level. When set to null, the field's value is unset, and
        the default timeout settings are applied.
      properties:
        absoluteSessionTimeoutInSeconds:
          description: Specifies the absolute session timeout duration in seconds.
            When set to null, the field's value is unset, and the default value of
            43,200 seconds (12 hours) is applied. Accepted values range between a
            minimum of 3,600 seconds (1 hour) and a maximum of 43,200 seconds (12
            hours).
          format: int32
          type: integer
        idleSessionTimeoutInSeconds:
          description: 'Specifies the idle session timeout duration in seconds. When
            set to null, the field''s value is unset, and the default behavior depends
            on the context: no timeout for Atlas Commercial, and 600 seconds (10 minutes)
            for Atlas for Government. Accepted values start at a minimum of 300 seconds
            (5 minutes). For Atlas Commercial, the maximum value cannot exceed the
            configured absolute session timeout. For Atlas for Government, the maximum
            value is capped at 600 seconds (10 minutes).'
          format: int32
          type: integer
      type: object
    CustomZoneMappings:
      properties:
        customZoneMappings:
          description: |-
            List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.

            This parameter returns an empty object if no custom zones exist.
          items:
            "$ref": "#/components/schemas/ZoneMapping"
          type: array
      required:
      - customZoneMappings
      type: object
    DBRoleToExecute:
      description: The name of a Built in or Custom DB Role to connect to an Atlas
        Cluster.
      externalDocs:
        description: Built-in Roles
        url: https://www.mongodb.com/docs/atlas/mongodb-users-roles-and-privileges/#mongodb-atlasrole-atlasAdmin
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        role:
          description: The name of the role to use. Can be a built in role or a custom
            role.
          type: string
        type:
          description: Type of the DB role. Can be either Built In or Custom.
          enum:
          - BUILT_IN
          - CUSTOM
          title: DB Role Type
          type: string
      type: object
    DBUserTLSX509Settings:
      description: Settings to configure TLS Certificates for database users.
      properties:
        cas:
          description: Concatenated list of customer certificate authority (CA) certificates
            needed to authenticate database users. MongoDB Cloud expects this as a
            PEM-formatted certificate.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      title: Database User TLS Certificate Settings
      type: object
    DLQRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DLSIngestionSink:
      allOf:
      - "$ref": "#/components/schemas/IngestionSink"
      - properties:
          metadataProvider:
            description: Target cloud provider for this Data Lake Pipeline.
            enum:
            - AWS
            type: string
          metadataRegion:
            description: Target cloud provider region for this Data Lake Pipeline.
            externalDocs:
              description: Supported cloud provider regions
              url: https://www.mongodb.com/docs/datalake/limitations
            type: string
          partitionFields:
            description: Ordered fields used to physically organize data in the destination.
            items:
              "$ref": "#/components/schemas/DataLakePipelinesPartitionField"
            type: array
        type: object
      description: Atlas Data Lake Storage as the destination for a Data Lake Pipeline.
      title: DLS Ingestion Destination
      type: object
    DailyScheduleView:
      allOf:
      - "$ref": "#/components/schemas/OnlineArchiveSchedule"
      - properties:
          endHour:
            description: Hour of the day when the scheduled window to run one online
              archive ends. This field uses the UTC time zone. The window must have
              a duration of at least two hours. If the end time is before or equal
              to the start time, the window extends to the next day.
            format: int32
            maximum: 23
            minimum: 0
            type: integer
          endMinute:
            description: Minute of the hour when the scheduled window to run one online
              archive ends. This field uses the UTC time zone. The window must have
              a duration of at least two hours. If the end time is before or equal
              to the start time, the window extends to the next day.
            format: int32
            maximum: 59
            minimum: 0
            type: integer
          startHour:
            description: Hour of the day when the scheduled window to run one online
              archive starts. This field uses the UTC time zone.
            format: int32
            maximum: 23
            minimum: 0
            type: integer
          startMinute:
            description: Minute of the hour when the scheduled window to run one online
              archive starts. This field uses the UTC time zone.
            format: int32
            maximum: 59
            minimum: 0
            type: integer
        type: object
      required:
      - type
      type: object
    DataExpirationRuleView:
      description: Rule for specifying when data should be deleted from the archive.
      properties:
        expireAfterDays:
          description: Number of days used in the date criteria for nominating documents
            for deletion.
          format: int32
          maximum: 9215
          minimum: 7
          type: integer
      type: object
    DataExplorerAccessedEventTypeView:
      description: Unique identifier of event type.
      enum:
      - DATA_EXPLORER
      - DATA_EXPLORER_CRUD_ATTEMPT
      - DATA_EXPLORER_CRUD_ERROR
      - DATA_EXPLORER_CRUD
      example: DATA_EXPLORER
      title: Data Explorer Accessed Event Types
      type: string
    DataExplorerAccessedEventView:
      description: Data Explorer accessed event tracks different data operations via
        Data Explorer interactions.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        collection:
          description: Human-readable label of the collection on which the event occurred.
            The resource returns this parameter when the `eventTypeName` includes
            `DATA_EXPLORER`.
          example: test_collection
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        database:
          description: 'Human-readable label of the database on which this incident
            occurred. The resource returns this parameter when `"eventTypeName" :
            "DATA_EXPLORER"` or `"eventTypeName" : "DATA_EXPLORER_CRUD"`.'
          example: test_db
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/DataExplorerAccessedEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        opType:
          description: 'Action that the database attempted to execute when the event
            triggered. The response returns this parameter when `eventTypeName" :
            "DATA_EXPLORER"`.'
          example: insertDocument
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Data Explorer Accessed Events
      type: object
    DataExplorerEvent:
      description: Data Explorer event tracks different Data Explorer operations.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/DataExplorerEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        sessionId:
          description: Unique 24-hexadecimal digit string that identifies the Data
            Explorer session associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Data Explorer Events
      type: object
    DataExplorerEventTypeView:
      description: Unique identifier of event type.
      enum:
      - DATA_EXPLORER_SESSION_CREATED
      example: DATA_EXPLORER_SESSION_CREATED
      title: Data Explorer Event Types
      type: string
    DataFederationAzureCloudProviderConfig:
      description: Configuration for running Data Federation in Azure.
      properties:
        atlasAppId:
          description: The App ID generated by Atlas for the Service Principal's access
            policy.
          readOnly: true
          type: string
        roleId:
          description: Unique identifier of the role that Data Federation can use
            to access the data stores. Required if specifying `cloudProviderConfig`.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        servicePrincipalId:
          description: The ID of the Service Principal for which there is an access
            policy for Atlas to access Azure resources.
          readOnly: true
          type: string
        tenantId:
          description: The Azure Active Directory / Entra ID tenant ID associated
            with the Service Principal.
          readOnly: true
          type: string
      required:
      - roleId
      type: object
    DataFederationGCPCloudProviderConfig:
      description: Configuration for running Data Federation in GCP.
      properties:
        gcpServiceAccount:
          description: The email address of the Google Cloud Platform (GCP) service
            account created by Atlas which should be authorized to allow Atlas to
            access Google Cloud Storage.
          readOnly: true
          type: string
        roleId:
          description: Unique identifier of the role that Data Federation can use
            to access the data stores. Required if specifying `cloudProviderConfig`.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      required:
      - roleId
      type: object
    DataFederationLimit:
      description: Details of user managed limits.
      discriminator:
        mapping:
          atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit"
          atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit"
          atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit"
          atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit"
          atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit"
          atlas.project.security.networkAccess.crossRegionEntries: "#/components/schemas/DefaultLimit"
          atlas.project.security.networkAccess.entries: "#/components/schemas/DefaultLimit"
        propertyName: name
      properties:
        currentUsage:
          description: Amount that indicates the current usage of the limit.
          format: int64
          readOnly: true
          type: integer
        defaultLimit:
          description: Default value of the limit.
          format: int64
          readOnly: true
          type: integer
        maximumLimit:
          description: Maximum value of the limit.
          format: int64
          readOnly: true
          type: integer
        name:
          description: Human-readable label that identifies the user-managed limit
            to modify.
          readOnly: true
          type: string
        value:
          description: Amount to set the limit to.
          format: int64
          type: integer
      required:
      - name
      - value
      title: Limits
      type: object
    DataFederationTenantQueryLimit:
      description: Details of a tenant-level query limit for Data Federation. Query
        limit is the limit on the amount of usage during a time period based on cost.
      properties:
        currentUsage:
          description: Amount that indicates the current usage of the limit.
          format: int64
          readOnly: true
          type: integer
        defaultLimit:
          description: Default value of the limit.
          format: int64
          readOnly: true
          type: integer
        lastModifiedDate:
          description: Only used for Data Federation limits. Timestamp that indicates
            when this usage limit was last modified. This field uses the ISO 8601
            timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        maximumLimit:
          description: Maximum value of the limit.
          format: int64
          readOnly: true
          type: integer
        name:
          description: Human-readable label that identifies the user-managed limit
            to modify.
          readOnly: true
          type: string
        overrunPolicy:
          description: Only used for Data Federation limits. Action to take when the
            usage limit is exceeded. If limit span is set to QUERY, this is ignored
            because MongoDB Cloud stops the query when it exceeds the usage limit.
          enum:
          - BLOCK
          - BLOCK_AND_KILL
          type: string
        tenantName:
          description: Human-readable label that identifies the Federated Database
            Instance. If specified, the usage limit is for the specified federated
            database instance only. If omitted, the usage limit is for all federated
            database instances in the project.
          readOnly: true
          type: string
        value:
          description: Amount to set the limit to.
          format: int64
          type: integer
      required:
      - name
      - value
      title: Data Federation Tenant-Level Query Limit
      type: object
    DataLakeAWSCloudProviderConfig:
      description: Configuration for running Data Federation in AWS.
      properties:
        externalId:
          description: Unique identifier associated with the Identity and Access Management
            (IAM) role that the data lake assumes when accessing the data stores.
          readOnly: true
          type: string
        iamAssumedRoleARN:
          description: Amazon Resource Name (ARN) of the Identity and Access Management
            (IAM) role that the data lake assumes when accessing data stores.
          example: arn:aws:iam::123456789012:root
          maxLength: 2048
          minLength: 20
          readOnly: true
          type: string
        iamUserARN:
          description: Amazon Resource Name (ARN) of the user that the data lake assumes
            when accessing data stores.
          readOnly: true
          type: string
        roleId:
          description: Unique identifier of the role that the data lake can use to
            access the data stores.Required if specifying cloudProviderConfig.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        testS3Bucket:
          description: Name of the S3 data bucket that the provided role ID is authorized
            to access. Required if specifying `cloudProviderConfig`.
          type: string
          writeOnly: true
      required:
      - roleId
      - testS3Bucket
      type: object
    DataLakeApiBase:
      description: An aggregation pipeline that applies to the collection.
      properties:
        name:
          description: Human-readable label that identifies the view, which corresponds
            to an aggregation pipeline on a collection.
          type: string
        pipeline:
          description: Aggregation pipeline stages to apply to the source collection.
          externalDocs:
            description: Aggregation Pipelines
            url: https://docs.mongodb.com/manual/core/aggregation-pipeline/
          type: string
        source:
          description: Human-readable label that identifies the source collection
            for the view.
          type: string
      type: object
    DataLakeAtlasStoreInstance:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          clusterName:
            description: Human-readable label of the MongoDB Cloud cluster on which
              the store is based.
            type: string
          projectId:
            description: Unique 24-hexadecimal digit string that identifies the project.
            maxLength: 24
            minLength: 24
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          readConcern:
            "$ref": "#/components/schemas/DataLakeAtlasStoreReadConcern"
          readPreference:
            "$ref": "#/components/schemas/DataLakeAtlasStoreReadPreference"
        type: object
      type: object
    DataLakeAtlasStoreReadConcern:
      description: MongoDB Cloud cluster read concern, which determines the consistency
        and isolation properties of the data read from an Atlas cluster.
      properties:
        level:
          description: Read Concern level that specifies the consistency and availability
            of the data read.
          enum:
          - LOCAL
          - MAJORITY
          - LINEARIZABLE
          - SNAPSHOT
          - AVAILABLE
          externalDocs:
            description: Read Concern Level
            url: https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels
          type: string
      type: object
    DataLakeAtlasStoreReadPreference:
      description: MongoDB Cloud cluster read preference, which describes how to route
        read requests to the cluster.
      properties:
        maxStalenessSeconds:
          description: Maximum replication lag, or **staleness**, for reads from secondaries.
          format: int32
          type: integer
        mode:
          description: Read preference mode that specifies to which replica set member
            to route the read requests.
          enum:
          - primary
          - primaryPreferred
          - secondary
          - secondaryPreferred
          - nearest
          externalDocs:
            description: Read Preference Modes
            url: https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes
          type: string
        tagSets:
          description: List that contains tag sets or tag specification documents.
            If specified, Atlas Data Lake routes read requests to replica set member
            or members that are associated with the specified tags.
          externalDocs:
            description: Read Preference Tag Set Lists
            url: https://docs.mongodb.com/manual/core/read-preference-tags/
          items:
            items:
              "$ref": "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag"
            type: array
          type: array
      type: object
    DataLakeAtlasStoreReadPreferenceTag:
      properties:
        name:
          description: Human-readable label of the tag.
          type: string
        value:
          description: Value of the tag.
          type: string
      type: object
    DataLakeAzureBlobStore:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          containerName:
            description: Human-readable label that identifies the name of the container.
            type: string
          delimiter:
            description: Delimiter.
            type: string
          prefix:
            description: Prefix.
            type: string
          public:
            default: false
            description: Flag that indicates whether the blob store is public. If
              set to `true`, MongoDB Cloud doesn't use the configured Azure service
              principal to access the blob store. If set to `false`, the configured
              Azure service principal must include permissions to access the blob
              store.
            type: boolean
          region:
            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
            title: Azure Regions
            type: string
          replacementDelimiter:
            description: Replacement Delimiter.
            type: string
          serviceURL:
            description: Service URL.
            type: string
        type: object
      type: object
    DataLakeCloudProviderConfig:
      description: Cloud provider where this Federated Database Instance is hosted.
      properties:
        aws:
          "$ref": "#/components/schemas/DataLakeAWSCloudProviderConfig"
        azure:
          "$ref": "#/components/schemas/DataFederationAzureCloudProviderConfig"
        gcp:
          "$ref": "#/components/schemas/DataFederationGCPCloudProviderConfig"
      title: Data Federation Cloud Provider
      type: object
    DataLakeDLSAWSStore:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          region:
            description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_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
            type: string
        type: object
      type: object
    DataLakeDLSAzureStore:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          region:
            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
            title: Azure Regions
            type: string
        type: object
      type: object
    DataLakeDLSGCPStore:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          region:
            description: Google Cloud Platform Regions.
            enum:
            - ASIA_EAST_2
            - ASIA_NORTHEAST_2
            - ASIA_NORTHEAST_3
            - ASIA_SOUTH_1
            - ASIA_SOUTH_2
            - ASIA_SOUTHEAST_2
            - AUSTRALIA_SOUTHEAST_1
            - AUSTRALIA_SOUTHEAST_2
            - CENTRAL_US
            - EASTERN_ASIA_PACIFIC
            - EASTERN_US
            - EUROPE_CENTRAL_2
            - EUROPE_NORTH_1
            - EUROPE_WEST_2
            - EUROPE_WEST_3
            - EUROPE_WEST_4
            - EUROPE_WEST_6
            - EUROPE_WEST_10
            - EUROPE_WEST_12
            - MIDDLE_EAST_CENTRAL_1
            - MIDDLE_EAST_CENTRAL_2
            - MIDDLE_EAST_WEST_1
            - NORTH_AMERICA_NORTHEAST_1
            - NORTH_AMERICA_NORTHEAST_2
            - NORTHEASTERN_ASIA_PACIFIC
            - SOUTH_AMERICA_EAST_1
            - SOUTH_AMERICA_WEST_1
            - SOUTHEASTERN_ASIA_PACIFIC
            - US_EAST_4
            - US_EAST_5
            - US_WEST_2
            - US_WEST_3
            - US_WEST_4
            - US_SOUTH_1
            - WESTERN_EUROPE
            - WESTERN_US
            title: GCP Regions
            type: string
        type: object
      type: object
    DataLakeDataProcessRegion:
      description: Information about the cloud provider region to which the Federated
        Database Instance routes client connections.
      properties:
        cloudProvider:
          description: Name of the cloud service that hosts the Federated Database
            Instance's infrastructure.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        region:
          "$ref": "#/components/schemas/BaseAtlasDataLakeRegion"
      required:
      - cloudProvider
      - region
      type: object
    DataLakeDatabaseCollection:
      description: A collection and data sources that map to a ``stores`` data store.
      properties:
        dataSources:
          description: Array that contains the data stores that map to a collection
            for this data lake.
          items:
            "$ref": "#/components/schemas/DataLakeDatabaseDataSourceSettings"
          type: array
        name:
          description: Human-readable label that identifies the collection to which
            MongoDB Cloud maps the data in the data stores.
          type: string
      type: object
    DataLakeDatabaseDataSourceSettings:
      description: Data store that maps to a collection for this data lake.
      properties:
        allowInsecure:
          default: false
          description: Flag that validates the scheme in the specified URLs. If `true`,
            allows insecure `HTTP` scheme, doesn't verify the server's certificate
            chain and hostname, and accepts any certificate with any hostname presented
            by the server. If `false`, allows secure `HTTPS` scheme only.
          type: boolean
        collection:
          description: Human-readable label that identifies the collection in the
            database. For creating a wildcard (`*`) collection, you must omit this
            parameter.
          type: string
        collectionRegex:
          description: Regex pattern to use for creating the wildcard (*) collection.
            To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp).
          type: string
        database:
          description: Human-readable label that identifies the database, which contains
            the collection in the cluster. You must omit this parameter to generate
            wildcard (`*`) collections for dynamically generated databases.
          type: string
        databaseRegex:
          description: Regex pattern to use for creating the wildcard (*) database.
            To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp).
          type: string
        datasetName:
          description: Human-readable label that identifies the dataset that Atlas
            generates for an ingestion pipeline run or Online Archive.
          example: v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z
          type: string
        datasetPrefix:
          description: Human-readable label that matches against the dataset names
            for ingestion pipeline runs or Online Archives.
          type: string
        defaultFormat:
          description: File format that MongoDB Cloud uses if it encounters a file
            without a file extension while searching **storeName**.
          enum:
          - ".avro"
          - ".avro.bz2"
          - ".avro.gz"
          - ".bson"
          - ".bson.bz2"
          - ".bson.gz"
          - ".bsonx"
          - ".csv"
          - ".csv.bz2"
          - ".csv.gz"
          - ".json"
          - ".json.bz2"
          - ".json.gz"
          - ".orc"
          - ".parquet"
          - ".tsv"
          - ".tsv.bz2"
          - ".tsv.gz"
          type: string
        path:
          description: File path that controls how MongoDB Cloud searches for and
            parses files in the **storeName** before mapping them to a collection.Specify
            ``/`` to capture all files and folders from the ``prefix`` path.
          type: string
        provenanceFieldName:
          description: Name for the field that includes the provenance of the documents
            in the results. MongoDB Cloud returns different fields in the results
            for each supported provider.
          type: string
        storeName:
          description: Human-readable label that identifies the data store that MongoDB
            Cloud maps to the collection.
          type: string
        trimLevel:
          description: Unsigned integer that specifies how many fields of the dataset
            name to trim from the left of the dataset name before mapping the remaining
            fields to a wildcard collection name.
          format: int32
          type: integer
        urls:
          description: URLs of the publicly accessible data files. You can't specify
            URLs that require authentication. Atlas Data Lake creates a partition
            for each URL. If empty or omitted, Data Lake uses the URLs from the store
            specified in the **dataSources.storeName** parameter.
          items:
            type: string
          type: array
      type: object
    DataLakeDatabaseInstance:
      description: Database associated with this data lake. Databases contain collections
        and views.
      properties:
        collections:
          description: Array of collections and data sources that map to a ``stores``
            data store.
          items:
            "$ref": "#/components/schemas/DataLakeDatabaseCollection"
          type: array
        maxWildcardCollections:
          default: 100
          description: Maximum number of wildcard collections in the database. This
            only applies to S3 data sources.
          format: int32
          maximum: 1000
          minimum: 1
          type: integer
        name:
          description: Human-readable label that identifies the database to which
            the data lake maps data.
          type: string
        views:
          description: Array of aggregation pipelines that apply to the collection.
            This only applies to S3 data sources.
          items:
            "$ref": "#/components/schemas/DataLakeApiBase"
          type: array
      type: object
    DataLakeGoogleCloudStorageStore:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          bucket:
            description: Human-readable label that identifies the Google Cloud Storage
              bucket.
            type: string
          delimiter:
            description: Delimiter.
            type: string
          prefix:
            description: Prefix.
            type: string
          public:
            default: false
            description: Flag that indicates whether the bucket is public. If set
              to `true`, MongoDB Cloud doesn't use the configured GCP service account
              to access the bucket. If set to `false`, the configured GCP service
              acccount must include permissions to access the bucket.
            type: boolean
          region:
            description: Google Cloud Platform Regions.
            enum:
            - ASIA_EAST_2
            - ASIA_NORTHEAST_2
            - ASIA_NORTHEAST_3
            - ASIA_SOUTH_1
            - ASIA_SOUTH_2
            - ASIA_SOUTHEAST_2
            - AUSTRALIA_SOUTHEAST_1
            - AUSTRALIA_SOUTHEAST_2
            - CENTRAL_US
            - EASTERN_ASIA_PACIFIC
            - EASTERN_US
            - EUROPE_CENTRAL_2
            - EUROPE_NORTH_1
            - EUROPE_WEST_2
            - EUROPE_WEST_3
            - EUROPE_WEST_4
            - EUROPE_WEST_6
            - EUROPE_WEST_10
            - EUROPE_WEST_12
            - MIDDLE_EAST_CENTRAL_1
            - MIDDLE_EAST_CENTRAL_2
            - MIDDLE_EAST_WEST_1
            - NORTH_AMERICA_NORTHEAST_1
            - NORTH_AMERICA_NORTHEAST_2
            - NORTHEASTERN_ASIA_PACIFIC
            - SOUTH_AMERICA_EAST_1
            - SOUTH_AMERICA_WEST_1
            - SOUTHEASTERN_ASIA_PACIFIC
            - US_EAST_4
            - US_EAST_5
            - US_WEST_2
            - US_WEST_3
            - US_WEST_4
            - US_SOUTH_1
            - WESTERN_EUROPE
            - WESTERN_US
            title: GCP Regions
            type: string
          replacementDelimiter:
            description: Replacement Delimiter.
            type: string
        type: object
      type: object
    DataLakeHTTPStore:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          allowInsecure:
            default: false
            description: Flag that validates the scheme in the specified URLs. If
              `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate
              chain and hostname, and accepts any certificate with any hostname presented
              by the server. If `false`, allows secure `HTTPS` scheme only.
            type: boolean
          defaultFormat:
            description: Default format that Data Lake assumes if it encounters a
              file without an extension while searching the `storeName`. If omitted,
              Data Lake attempts to detect the file type by processing a few bytes
              of the file. The specified format only applies to the URLs specified
              in the **databases.[n].collections.[n].dataSources** object.
            type: string
          urls:
            description: Comma-separated list of publicly accessible HTTP URLs where
              data is stored. You can't specify URLs that require authentication.
            items:
              description: Comma-separated list of publicly accessible HTTP URLs where
                data is stored. You can't specify URLs that require authentication.
              type: string
            type: array
        type: object
      type: object
    DataLakeIngestionPipeline:
      description: Details of a Data Lake Pipeline.
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the Data
            Lake Pipeline.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        createdDate:
          description: Timestamp that indicates when the Data Lake Pipeline was created.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        datasetRetentionPolicy:
          "$ref": "#/components/schemas/DatasetRetentionPolicy"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the group.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastUpdatedDate:
          description: Timestamp that indicates the last time that the Data Lake Pipeline
            was updated. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          format: date-time
          readOnly: true
          type: string
        name:
          description: Name of this Data Lake Pipeline.
          type: string
        sink:
          "$ref": "#/components/schemas/IngestionSink"
        source:
          "$ref": "#/components/schemas/IngestionSource"
        state:
          description: State of this Data Lake Pipeline.
          enum:
          - ACTIVE
          - PAUSED
          readOnly: true
          type: string
        transformations:
          description: Fields to be excluded for this Data Lake Pipeline.
          items:
            "$ref": "#/components/schemas/FieldTransformation"
          type: array
      title: Data Lake Pipeline
      type: object
    DataLakePipelinesPartitionField:
      description: Partition Field in the Data Lake Storage provider for a Data Lake
        Pipeline.
      properties:
        fieldName:
          description: Human-readable label that identifies the field name used to
            partition data.
          maxLength: 700
          type: string
        order:
          default: 0
          description: Sequence in which MongoDB Cloud slices the collection data
            to create partitions. The resource expresses this sequence starting with
            zero.
          format: int32
          type: integer
      required:
      - fieldName
      - order
      title: Partition Field
      type: object
    DataLakeS3StoreSettings:
      allOf:
      - "$ref": "#/components/schemas/DataLakeStoreSettings"
      - properties:
          additionalStorageClasses:
            description: Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/).
              Atlas Data Lake includes the files in these storage classes in the query
              results.
            items:
              description: AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/)
                where the files to include in the results are stored.
              enum:
              - STANDARD
              - INTELLIGENT_TIERING
              - STANDARD_IA
              type: string
            type: array
          bucket:
            description: Human-readable label that identifies the AWS S3 bucket. This
              label must exactly match the name of an S3 bucket that the data lake
              can access with the configured AWS Identity and Access Management (IAM)
              credentials.
            type: string
          delimiter:
            description: The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path**
              segments in the data store. MongoDB Cloud uses the delimiter to efficiently
              traverse S3 buckets with a hierarchical directory structure. You can
              specify any character supported by the S3 object keys as the delimiter.
              For example, you can specify an underscore (_) or a plus sign (+) or
              multiple characters, such as double underscores (__) as the delimiter.
              If omitted, defaults to `/`.
            type: string
          includeTags:
            default: false
            description: Flag that indicates whether to use S3 tags on the files in
              the given path as additional partition attributes. If set to `true`,
              data lake adds the S3 tags as additional partition attributes and adds
              new top-level BSON elements associating each tag to each document.
            type: boolean
          prefix:
            description: Prefix that MongoDB Cloud applies when searching for files
              in the S3 bucket. The data store prepends the value of prefix to the
              **databases.[n].collections.[n].dataSources.[n].path** to create the
              full path for files to ingest. If omitted, MongoDB Cloud searches all
              files from the root of the S3 bucket.
            type: string
          public:
            default: false
            description: Flag that indicates whether the bucket is public. If set
              to `true`, MongoDB Cloud doesn't use the configured AWS Identity and
              Access Management (IAM) role to access the S3 bucket. If set to `false`,
              the configured AWS IAM role must include permissions to access the S3
              bucket.
            type: boolean
          region:
            description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_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
            type: string
        type: object
      type: object
    DataLakeStorage:
      description: Configuration information for each data store and its mapping to
        MongoDB Cloud databases.
      properties:
        databases:
          description: Array that contains the queryable databases and collections
            for this data lake.
          items:
            "$ref": "#/components/schemas/DataLakeDatabaseInstance"
          type: array
        stores:
          description: Array that contains the data stores for the data lake.
          items:
            "$ref": "#/components/schemas/DataLakeStoreSettings"
          type: array
      type: object
    DataLakeStoreSettings:
      description: Group of settings that define where the data is stored.
      discriminator:
        mapping:
          atlas: "#/components/schemas/DataLakeAtlasStoreInstance"
          azure: "#/components/schemas/DataLakeAzureBlobStore"
          dls:aws: "#/components/schemas/DataLakeDLSAWSStore"
          dls:azure: "#/components/schemas/DataLakeDLSAzureStore"
          dls:gcp: "#/components/schemas/DataLakeDLSGCPStore"
          gcs: "#/components/schemas/DataLakeGoogleCloudStorageStore"
          http: "#/components/schemas/DataLakeHTTPStore"
          s3: "#/components/schemas/DataLakeS3StoreSettings"
        propertyName: provider
      oneOf:
      - "$ref": "#/components/schemas/DataLakeS3StoreSettings"
      - "$ref": "#/components/schemas/DataLakeDLSAWSStore"
      - "$ref": "#/components/schemas/DataLakeDLSAzureStore"
      - "$ref": "#/components/schemas/DataLakeDLSGCPStore"
      - "$ref": "#/components/schemas/DataLakeAtlasStoreInstance"
      - "$ref": "#/components/schemas/DataLakeHTTPStore"
      - "$ref": "#/components/schemas/DataLakeAzureBlobStore"
      - "$ref": "#/components/schemas/DataLakeGoogleCloudStorageStore"
      properties:
        name:
          description: Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName**
            field references this values as part of the mapping configuration. To
            use MongoDB Cloud as a data store, the data lake requires a serverless
            instance or an `M10` or higher cluster.
          type: string
        provider:
          type: string
      required:
      - provider
      type: object
    DataLakeTenant:
      properties:
        cloudProviderConfig:
          "$ref": "#/components/schemas/DataLakeCloudProviderConfig"
        dataProcessRegion:
          "$ref": "#/components/schemas/DataLakeDataProcessRegion"
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnames:
          description: List that contains the hostnames assigned to the Federated
            Database Instance.
          items:
            description: Unique hostname assigned to the Federated Database Instance.
            readOnly: true
            type: string
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the Federated Database
            Instance.
          type: string
        privateEndpointHostnames:
          description: List that contains the sets of private endpoints and hostnames.
          items:
            "$ref": "#/components/schemas/PrivateEndpointHostname"
          readOnly: true
          type: array
        state:
          description: Label that indicates the status of the Federated Database Instance.
          enum:
          - UNVERIFIED
          - ACTIVE
          - DELETED
          readOnly: true
          type: string
        storage:
          "$ref": "#/components/schemas/DataLakeStorage"
      type: object
    DataMetricAlertView:
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/DataMetricValueView"
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: |-
            Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.

            To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.

            **NOTE**: If you set `eventTypeName` to `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
          example: ASSERT_USER
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      type: object
    DataMetricEventView:
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/DataMetricValueView"
        deskLocation:
          description: Desk location of MongoDB employee associated with the event.
          readOnly: true
          type: string
        employeeIdentifier:
          description: Identifier of MongoDB employee associated with the event.
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: Human-readable label of the metric associated with the `alertId`.
            This field may change type of `currentValue` field.
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      type: object
    DataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    DataMetricUnits:
      description: Element used to express the quantity. This can be an element of
        time, storage capacity, and the like.
      enum:
      - BITS
      - KILOBITS
      - MEGABITS
      - GIGABITS
      - BYTES
      - KILOBYTES
      - MEGABYTES
      - GIGABYTES
      - TERABYTES
      - PETABYTES
      example: BYTES
      title: Data Metric Units
      type: string
    DataMetricValueView:
      description: Measurement of the `metricName` recorded at the time of the event.
      properties:
        number:
          description: Amount of the `metricName` recorded at the time of the event.
            This value triggered the alert.
          format: double
          readOnly: true
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      readOnly: true
      title: Data Metric Value
      type: object
    DataProcessRegionView:
      description: Settings to configure the region where you wish to store your archived
        data.
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSDataProcessRegionView"
          AZURE: "#/components/schemas/AzureDataProcessRegionView"
          GCP: "#/components/schemas/GCPDataProcessRegionView"
        propertyName: cloudProvider
      properties:
        cloudProvider:
          description: Human-readable label that identifies the Cloud service provider
            where you store your archived data.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
      readOnly: true
      type: object
    DataProtectionSettings20231001:
      properties:
        authorizedEmail:
          description: Email address of the user who authorized to update the Backup
            Compliance Policy  settings.
          format: email
          type: string
        authorizedUserFirstName:
          description: First name of the user who authorized to updated the Backup
            Compliance Policy  settings.
          type: string
        authorizedUserLastName:
          description: Last name of the user who authorized to updated the Backup
            Compliance Policy  settings.
          type: string
        copyProtectionEnabled:
          default: false
          description: Flag that indicates whether to prevent cluster users from deleting
            backups copied to other regions, even if those additional snapshot regions
            are removed. If unspecified, this value defaults to false.
          type: boolean
        deletable:
          default: false
          description: Flag that indicates whether the Backup Compliance Policy is
            allowed to be disabled. It is default to false and a support ticket needs
            to be filed to request setting to true.
          externalDocs:
            description: Configure a Backup Compliance Policy
            url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/
          readOnly: true
          type: boolean
        encryptionAtRestEnabled:
          default: false
          description: Flag that indicates whether Encryption at Rest using Customer
            Key  Management is required for all clusters with a Backup Compliance
            Policy. If unspecified, this value defaults to false.
          externalDocs:
            description: Encryption at Rest using Customer Key Management
            url: https://www.mongodb.com/docs/atlas/security-kms-encryption/
          type: boolean
        onDemandPolicyItem:
          "$ref": "#/components/schemas/BackupComplianceOnDemandPolicyItem"
        pitEnabled:
          default: false
          description: Flag that indicates whether the cluster uses Continuous Cloud
            Backups with a Backup Compliance Policy. If unspecified, this value defaults
            to false.
          externalDocs:
            description: Continuous Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        projectId:
          description: Unique 24-hexadecimal digit string that identifies the project
            for the Backup Compliance Policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        restoreWindowDays:
          description: Number of previous days that you can restore back to with Continuous
            Cloud Backup with a Backup Compliance Policy. You must specify a positive,
            non-zero integer, and the maximum retention window can't exceed the hourly
            retention time. This parameter applies only to Continuous Cloud Backups
            with a Backup Compliance Policy.
          format: int32
          type: integer
        scheduledPolicyItems:
          description: List that contains the specifications for one scheduled policy.
          items:
            "$ref": "#/components/schemas/BackupComplianceScheduledPolicyItem"
          type: array
        state:
          description: Label that indicates the state of the Backup Compliance Policy
            settings. MongoDB Cloud ignores this setting when you enable or update
            the Backup Compliance Policy settings.
          enum:
          - ACTIVE
          - ENABLING
          - UPDATING
          - DISABLING
          readOnly: true
          type: string
        updatedDate:
          description: ISO 8601 timestamp format in UTC that indicates when the user
            updated the Data Protection Policy settings. MongoDB Cloud ignores this
            setting when you enable or update the Backup Compliance Policy settings.
          format: date-time
          readOnly: true
          type: string
        updatedUser:
          description: Email address that identifies the user who updated the Backup
            Compliance Policy settings. MongoDB Cloud ignores this email setting when
            you enable or update the Backup Compliance Policy settings.
          format: email
          readOnly: true
          type: string
      required:
      - authorizedEmail
      - authorizedUserFirstName
      - authorizedUserLastName
      type: object
    DatabaseInheritedRole:
      description: Role inherited from another context for this database user.
      externalDocs:
        description: Built-in MongoDB Roles
        url: https://docs.mongodb.com/manual/reference/built-in-roles/
      properties:
        db:
          description: Human-readable label that identifies the database on which
            someone grants the action to one MongoDB user.
          type: string
        role:
          description: Human-readable label that identifies the role inherited. Set
            this value to `admin` for every role except `read` or `readWrite`.
          externalDocs:
            description: MongoDB Built-In Roles
            url: https://docs.mongodb.com/manual/reference/built-in-roles/
          type: string
      required:
      - db
      - role
      title: Inherited Role
      type: object
    DatabasePermittedNamespaceResource:
      description: Namespace to which this database user has access.
      externalDocs:
        description: Cluster Resources
        url: https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource
      properties:
        cluster:
          description: Flag that indicates whether to grant the action on the cluster
            resource. If `true`, MongoDB Cloud ignores the `actions.resources.collection`
            and `actions.resources.db` parameters.
          type: boolean
        collection:
          description: 'Human-readable label that identifies the collection on which
            you grant the action to one MongoDB user. If you don''t set this parameter,
            you grant the action to all collections in the database specified in the
            `actions.resources.db` parameter. If you set `"actions.resources.cluster"
            : true`, MongoDB Cloud ignores this parameter.'
          type: string
        db:
          description: 'Human-readable label that identifies the database on which
            you grant the action to one MongoDB user. If you set `"actions.resources.cluster"
            : true`, MongoDB Cloud ignores this parameter.'
          type: string
      required:
      - cluster
      - collection
      - db
      title: Permitted Namespace
      type: object
    DatabasePrivilegeAction:
      description: Privilege action that the role grants.
      properties:
        action:
          description: Human-readable label that identifies the privilege action.
          enum:
          - FIND
          - INSERT
          - REMOVE
          - UPDATE
          - BYPASS_DOCUMENT_VALIDATION
          - USE_UUID
          - KILL_OP
          - BYPASS_DEFAULT_MAX_TIME_MS
          - CREATE_COLLECTION
          - CREATE_INDEX
          - DROP_COLLECTION
          - ENABLE_PROFILER
          - KILL_ANY_CURSOR
          - CHANGE_STREAM
          - COLL_MOD
          - COMPACT
          - CONVERT_TO_CAPPED
          - DROP_DATABASE
          - DROP_INDEX
          - RE_INDEX
          - RENAME_COLLECTION_SAME_DB
          - SET_USER_WRITE_BLOCK
          - BYPASS_USER_WRITE_BLOCK
          - LIST_SESSIONS
          - KILL_ANY_SESSION
          - COLL_STATS
          - CONN_POOL_STATS
          - DB_HASH
          - DB_STATS
          - GET_CMD_LINE_OPTS
          - GET_LOG
          - GET_PARAMETER
          - GET_SHARD_MAP
          - HOST_INFO
          - IN_PROG
          - LIST_DATABASES
          - LIST_COLLECTIONS
          - LIST_INDEXES
          - LIST_SHARDS
          - NET_STAT
          - REPL_SET_GET_CONFIG
          - REPL_SET_GET_STATUS
          - SERVER_STATUS
          - VALIDATE
          - SHARDING_STATE
          - TOP
          - SQL_GET_SCHEMA
          - SQL_SET_SCHEMA
          - VIEW_ALL_HISTORY
          - OUT_TO_S3
          - OUT_TO_AZURE
          - OUT_TO_GCS
          - STORAGE_GET_CONFIG
          - STORAGE_SET_CONFIG
          - FLUSH_ROUTER_CONFIG
          - ENABLE_SHARDING
          - CHECK_METADATA_CONSISTENCY
          - MOVE_CHUNK
          - SPLIT_CHUNK
          - ANALYZE_SHARD_KEY
          - REFINE_COLLECTION_SHARD_KEY
          - CLEAR_JUMBO_FLAG
          - RESHARD_COLLECTION
          - SHARDED_DATA_DISTRIBUTION
          - GET_STREAM_PROCESSOR
          - CREATE_STREAM_PROCESSOR
          - PROCESS_STREAM_PROCESSOR
          - MODIFY_STREAM_PROCESSOR
          - START_STREAM_PROCESSOR
          - STOP_STREAM_PROCESSOR
          - DROP_STREAM_PROCESSOR
          - SAMPLE_STREAM_PROCESSOR
          - LIST_STREAM_PROCESSORS
          - LIST_CONNECTIONS
          - STREAM_PROCESSOR_STATS
          type: string
        resources:
          description: List of resources on which you grant the action.
          items:
            "$ref": "#/components/schemas/DatabasePermittedNamespaceResource"
          type: array
      required:
      - action
      - resources
      title: Database Privilege Action
      type: object
    DatabaseRollingIndexRequest:
      properties:
        collation:
          "$ref": "#/components/schemas/Collation"
        collection:
          description: Human-readable label of the collection for which MongoDB Cloud
            creates an index.
          type: string
          writeOnly: true
        db:
          description: Human-readable label of the database that holds the collection
            on which MongoDB Cloud creates an index.
          type: string
          writeOnly: true
        keys:
          description: List that contains one or more objects that describe the parameters
            that you want to index.
          items:
            additionalProperties:
              description: Key-value pair that sets the parameter to index as the
                key and the type of index as its value. To create a [multi-key index](https://docs.mongodb.com/manual/core/index-multikey/),
                list each parameter in its own object within this array.
              externalDocs:
                description: Index Types
                url: https://docs.mongodb.com/manual/indexes/#index-types
              maxProperties: 1
              minProperties: 1
              type: string
              writeOnly: true
            description: Key-value pair that sets the parameter to index as the key
              and the type of index as its value. To create a [multi-key index](https://docs.mongodb.com/manual/core/index-multikey/),
              list each parameter in its own object within this array.
            externalDocs:
              description: Index Types
              url: https://docs.mongodb.com/manual/indexes/#index-types
            maxProperties: 1
            minProperties: 1
            type: object
            writeOnly: true
          type: array
          writeOnly: true
        options:
          "$ref": "#/components/schemas/IndexOptions"
      required:
      - collection
      - db
      - keys
      type: object
    DatabaseUserRole:
      description: Range of resources available to this database user.
      properties:
        collectionName:
          description: Collection on which this role applies.
          type: string
        databaseName:
          description: Database to which the user is granted access privileges.
          type: string
        roleName:
          description: Human-readable label that identifies a group of privileges
            assigned to a database user. This value can either be a built-in role
            or a custom role.
          enum:
          - atlasAdmin
          - backup
          - clusterMonitor
          - dbAdmin
          - dbAdminAnyDatabase
          - enableSharding
          - read
          - readAnyDatabase
          - readWrite
          - readWriteAnyDatabase
          - "<a custom role name>"
          type: string
      required:
      - databaseName
      - roleName
      title: Database User Role
      type: object
    Datadog:
      description: Details to integrate one Datadog account with one MongoDB Cloud
        project.
      properties:
        apiKey:
          description: |-
            Key that allows MongoDB Cloud to access your Datadog account.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "****************************a23c"
          type: string
        id:
          description: Integration id.
          nullable: true
          type: string
        region:
          description: Two-letter code that indicates which regional URL MongoDB uses
            to access the Datadog API.
          enum:
          - US
          - EU
          - US3
          - US5
          - AP1
          - US1_FED
          externalDocs:
            description: Datadog regions
            url: https://docs.datadoghq.com/getting_started/site/
          type: string
        sendCollectionLatencyMetrics:
          default: false
          description: Toggle sending collection latency metrics that includes database
            names and collection names and latency metrics on reads, writes, commands,
            and transactions.
          type: boolean
        sendDatabaseMetrics:
          default: false
          description: Toggle sending database metrics that includes database names
            and metrics on the number of collections, storage size, and index size.
          type: boolean
        sendQueryStatsMetrics:
          default: false
          description: Toggle sending query shape metrics that includes query hash
            and metrics on latency, execution frequency, documents returned, and timestamps.
          type: boolean
        sendUserProvidedResourceTags:
          default: false
          description: Toggle sending user provided group and cluster resource tags
            with the Datadog metrics.
          type: boolean
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - DATADOG
          type: string
      required:
      - apiKey
      title: DATADOG
      type: object
    DatadogLogIntegrationRequest:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationRequest"
      - properties:
          apiKey:
            description: API key for authentication.
            example: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
            format: password
            type: string
          region:
            description: 'Datadog site/region for log ingestion. Valid values: US1,
              US3, US5, EU, AP1, AP2, US1_FED.'
            enum:
            - US1
            - US3
            - US5
            - EU
            - AP1
            - AP2
            - US1_FED
            example: US1
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - DATADOG_LOG_EXPORT
            type: string
        type: object
      description: Request schema for creating or updating a Datadog log export integration.
      required:
      - apiKey
      - logTypes
      - region
      - type
      title: Datadog Log Export Integration Request
      type: object
    DatadogLogIntegrationResponse:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationResponse"
      - properties:
          apiKey:
            description: API key for authentication.
            example: "****************************o5p6"
            format: password
            type: string
          region:
            description: 'Datadog site/region for log ingestion. Valid values: US1,
              US3, US5, EU, AP1, AP2, US1_FED.'
            enum:
            - US1
            - US3
            - US5
            - EU
            - AP1
            - AP2
            - US1_FED
            example: US1
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - DATADOG_LOG_EXPORT
            type: string
        type: object
      description: Details to integrate Datadog log export with one Atlas project.
      required:
      - apiKey
      - id
      - logTypes
      - region
      - type
      title: Datadog Log Export Integration Response
      type: object
    DatadogNotification:
      description: Datadog notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        datadogApiKey:
          description: |-
            Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `"notifications.[n].typeName" : "DATADOG"`.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "****************************a23c"
          type: string
        datadogRegion:
          default: US
          description: 'Datadog region that indicates which API Uniform Resource Locator
            (URL) to use. The resource requires this parameter when `"notifications.[n].typeName"
            : "DATADOG"`.'
          enum:
          - US
          - EU
          - US3
          - US5
          - AP1
          - US1_FED
          externalDocs:
            description: Datadog regions
            url: https://docs.datadoghq.com/getting_started/site/
          type: string
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - DATADOG
          type: string
      required:
      - typeName
      title: Datadog Notification
      type: object
    DatasetRetentionPolicy:
      description: Dataset Retention Policy for a Scheduled Data Lake Pipeline.
      properties:
        lastModifiedDate:
          description: Date when retention policy was last modified. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        units:
          description: Quantity of time in which the Data Lake Pipeline measures dataset
            retention.
          enum:
          - DAYS
          - WEEKS
          - MONTHS
          type: string
        value:
          description: Number that indicates the amount of days, weeks, or months
            that the Data Lake Pipeline will retain datasets.
          format: int32
          minimum: 1
          type: integer
      required:
      - units
      - value
      title: Dataset Retention Policy
      type: object
    DateCriteriaView:
      allOf:
      - "$ref": "#/components/schemas/CriteriaView"
      - properties:
          dateField:
            description: 'Indexed database parameter that stores the date that determines
              when data moves to the online archive. MongoDB Cloud archives the data
              when the current date exceeds the date in this database parameter plus
              the number of days specified through the `expireAfterDays` parameter.
              Set this parameter when you set `"criteria.type" : "DATE"`.'
            type: string
          dateFormat:
            default: ISODATE
            description: |-
              Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601, Epoch timestamps, or Object ID. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when `criteria.type` : `DATE`.
              You must set `criteria.type` : `DATE` if `collectionType`: `TIMESERIES`.
            enum:
            - ISODATE
            - EPOCH_SECONDS
            - EPOCH_MILLIS
            - EPOCH_NANOSECONDS
            - OBJECT_ID
            type: string
          expireAfterDays:
            description: 'Number of days after the value in the `criteria.dateField`
              when MongoDB Cloud archives data in the specified cluster. Set this
              parameter when you set `"criteria.type" : "DATE"`.'
            format: int32
            type: integer
        type: object
      description: Date-Based archival criteria.
      title: Archival Criteria
      type: object
    DbDataSizeTotalDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    DbDataSizeTotalWoSystemDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    DbIndexSizeTotalDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    DbStorageTotalDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    DedicatedHardwareSpec20240805:
      description: The current hardware specifications for read only nodes in the
        region.
      oneOf:
      - "$ref": "#/components/schemas/AWSHardwareSpec20240805"
      - "$ref": "#/components/schemas/AzureHardwareSpec20240805"
      - "$ref": "#/components/schemas/GCPHardwareSpec20240805"
      properties:
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value must be equal for
            all shards and node types.\n\n This value is not configurable on M0/M2/M5
            clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n
            If you specify a disk size below the minimum (10 GB), this parameter defaults
            to the minimum disk size value. \n\n Storage charge calculations depend
            on whether you choose the default value or a custom value.\n\n The maximum
            value for disk storage cannot exceed 50 times the maximum RAM for the
            selected cluster. If you require more storage space, consider upgrading
            your cluster to a higher tier."
          externalDocs:
            description: Customize Storage
            url: https://dochub.mongodb.org/core/customize-storage
          format: double
          type: number
        nodeCount:
          description: Number of nodes of the given type for MongoDB Cloud to deploy
            to the region.
          format: int32
          type: integer
      readOnly: true
      type: object
    DefaultAlertConfigViewForNdsGroup:
      description: Other alerts which don't have extra details beside of basic one.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          description: Incident that triggered this alert.
          externalDocs:
            description: Atlas Alert Event Types
            url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
          oneOf:
          - enum:
            - CREDIT_CARD_ABOUT_TO_EXPIRE
            title: Billing Event Types
            type: string
          - enum:
            - CPS_SNAPSHOT_STARTED
            - CPS_SNAPSHOT_SUCCESSFUL
            - CPS_SNAPSHOT_FAILED
            - CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY
            - CPS_SNAPSHOT_FALLBACK_SUCCESSFUL
            - CPS_SNAPSHOT_FALLBACK_FAILED
            - CPS_COPY_SNAPSHOT_STARTED
            - CPS_COPY_SNAPSHOT_FAILED
            - CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY
            - CPS_COPY_SNAPSHOT_SUCCESSFUL
            - CPS_RESTORE_SUCCESSFUL
            - CPS_EXPORT_SUCCESSFUL
            - CPS_RESTORE_FAILED
            - CPS_EXPORT_FAILED
            - CPS_COLLECTION_RESTORE_SUCCESSFUL
            - CPS_COLLECTION_RESTORE_FAILED
            - CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS
            - CPS_COLLECTION_RESTORE_CANCELED
            - CPS_AUTO_EXPORT_FAILED
            - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED
            - CPS_OPLOG_CAUGHT_UP
            title: Cps Backup Event Types
            type: string
          - enum:
            - CPS_DATA_PROTECTION_ENABLE_REQUESTED
            - CPS_DATA_PROTECTION_ENABLED
            - CPS_DATA_PROTECTION_UPDATE_REQUESTED
            - CPS_DATA_PROTECTION_UPDATED
            - CPS_DATA_PROTECTION_DISABLE_REQUESTED
            - CPS_DATA_PROTECTION_DISABLED
            - CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT
            title: Data Protection Event Types
            type: string
          - enum:
            - FTS_INDEX_DELETION_FAILED
            - FTS_INDEX_BUILD_COMPLETE
            - FTS_INDEX_BUILD_FAILED
            - FTS_INDEX_CLEANED_UP
            - FTS_INDEX_STALE
            - FTS_INDEXES_RESTORE_FAILED
            - FTS_INDEXES_SYNONYM_MAPPING_INVALID
            title: FTS Index Audit Types
            type: string
          - enum:
            - USERS_WITHOUT_MULTI_FACTOR_AUTH
            - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED
            - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID
            - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING
            - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED
            - ACTIVE_LEGACY_TLS_CONNECTIONS
            title: Group Event Types
            type: string
          - enum:
            - MONGOTUNE_ALERT
            title: Mongotune Event Types
            type: string
          - enum:
            - CLUSTER_INSTANCE_STOP_START
            - CLUSTER_INSTANCE_RESYNC_REQUESTED
            - CLUSTER_INSTANCE_UPDATE_REQUESTED
            - SAMPLE_DATASET_LOAD_REQUESTED
            - TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL
            - TENANT_UPGRADE_TO_SERVERLESS_FAILED
            - NETWORK_PERMISSION_ENTRY_ADDED
            - NETWORK_PERMISSION_ENTRY_REMOVED
            - NETWORK_PERMISSION_ENTRY_UPDATED
            - CLUSTER_BLOCK_WRITE
            - CLUSTER_UNBLOCK_WRITE
            title: Atlas Audit Types
            type: string
          - enum:
            - MAINTENANCE_IN_ADVANCED
            - MAINTENANCE_AUTO_DEFERRED
            - MAINTENANCE_STARTED
            - MAINTENANCE_COMPLETED
            - MAINTENANCE_NO_LONGER_NEEDED
            title: Maintenance Window Audit Types
            type: string
          - enum:
            - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK
            - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK
            title: Online Archive Event Types
            type: string
          - enum:
            - JOINED_GROUP
            - REMOVED_FROM_GROUP
            - USER_ROLES_CHANGED_AUDIT
            title: User Event Types
            type: string
          - enum:
            - TAGS_MODIFIED
            - CLUSTER_TAGS_MODIFIED
            - GROUP_TAGS_MODIFIED
            title: Resource Event Types
            type: string
          - enum:
            - STREAM_PROCESSOR_STATE_IS_FAILED
            - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
            title: Stream Processor Event Types
            type: string
          - enum:
            - COMPUTE_AUTO_SCALE_INITIATED_BASE
            - COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS
            - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE
            - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS
            - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_BASE
            - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_ANALYTICS
            - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
            - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS
            - COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
            - COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS
            - DISK_AUTO_SCALE_INITIATED
            - DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL
            - DISK_AUTO_SCALE_OPLOG_FAIL
            - PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE
            - PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
            - PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
            - CLUSTER_AUTO_SHARDING_INITIATED
            title: Auto Scaling Audit Types
            type: string
          - enum:
            - RESOURCE_POLICY_VIOLATED
            title: Atlas Resource Policy Audit Types
            type: string
          - enum:
            - HOST_DOWN
            - HOST_HAS_INDEX_SUGGESTIONS
            - HOST_MONGOT_CRASHING_OOM
            - HOST_MONGOT_STOP_REPLICATION
            - HOST_MONGOT_APPROACHING_STOP_REPLICATION
            - HOST_MONGOT_PAUSE_INITIAL_SYNC
            - HOST_SEARCH_NODE_INDEX_FAILED
            - HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN
            - HOST_NOT_ENOUGH_DISK_SPACE
            - SSH_KEY_NDS_HOST_ACCESS_REQUESTED
            - SSH_KEY_NDS_HOST_ACCESS_REFRESHED
            - PUSH_BASED_LOG_EXPORT_STOPPED
            - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
            - HOST_VERSION_BEHIND
            - VERSION_BEHIND
            - HOST_EXPOSED
            - HOST_SSL_CERTIFICATE_STALE
            - HOST_SECURITY_CHECKUP_NOT_MET
            - ALERT_HOST_SSH_SESSION_STARTED
            - PROFILER_CONFIGURED_TOO_WIDELY
            title: Host Event Types
            type: string
          type: object
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Any Other Alert Configurations
      type: object
    DefaultAlertViewForNdsGroup:
      description: Other alerts which don't have extra details beside of basic one.
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          description: Incident that triggered this alert.
          oneOf:
          - enum:
            - CREDIT_CARD_ABOUT_TO_EXPIRE
            - PENDING_INVOICE_OVER_THRESHOLD
            - DAILY_BILL_OVER_THRESHOLD
            - DAILY_BILLING_CHANGE_OVER_THRESHOLD
            - WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
            - MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
            title: Billing Event Types
            type: string
          - enum:
            - CPS_SNAPSHOT_STARTED
            - CPS_SNAPSHOT_SUCCESSFUL
            - CPS_SNAPSHOT_FAILED
            - CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY
            - CPS_SNAPSHOT_BEHIND
            - CPS_COPY_SNAPSHOT_STARTED
            - CPS_COPY_SNAPSHOT_FAILED
            - CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY
            - CPS_COPY_SNAPSHOT_SUCCESSFUL
            - CPS_PREV_SNAPSHOT_OLD
            - CPS_SNAPSHOT_FALLBACK_SUCCESSFUL
            - CPS_SNAPSHOT_FALLBACK_FAILED
            - CPS_RESTORE_SUCCESSFUL
            - CPS_EXPORT_SUCCESSFUL
            - CPS_RESTORE_FAILED
            - CPS_EXPORT_FAILED
            - CPS_COLLECTION_RESTORE_SUCCESSFUL
            - CPS_COLLECTION_RESTORE_FAILED
            - CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS
            - CPS_COLLECTION_RESTORE_CANCELED
            - CPS_AUTO_EXPORT_FAILED
            - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED
            - CPS_OPLOG_BEHIND
            - CPS_OPLOG_CAUGHT_UP
            title: Cps Backup Event Types
            type: string
          - enum:
            - AWS_ENCRYPTION_KEY_NEEDS_ROTATION
            - AZURE_ENCRYPTION_KEY_NEEDS_ROTATION
            - GCP_ENCRYPTION_KEY_NEEDS_ROTATION
            - AWS_ENCRYPTION_KEY_INVALID
            - AZURE_ENCRYPTION_KEY_INVALID
            - GCP_ENCRYPTION_KEY_INVALID
            title: Encryption Event Types
            type: string
          - enum:
            - FTS_INDEX_DELETION_FAILED
            - FTS_INDEX_BUILD_COMPLETE
            - FTS_INDEX_BUILD_FAILED
            - FTS_INDEX_CLEANED_UP
            - FTS_INDEX_STALE
            - FTS_INDEXES_RESTORE_FAILED
            - FTS_INDEXES_SYNONYM_MAPPING_INVALID
            title: FTS Index Audit Types
            type: string
          - enum:
            - USERS_WITHOUT_MULTI_FACTOR_AUTH
            - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED
            - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID
            - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING
            - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED
            - ACTIVE_LEGACY_TLS_CONNECTIONS
            title: Group Event Types
            type: string
          - enum:
            - MONGOTUNE_ALERT
            title: Mongotune Event Types
            type: string
          - enum:
            - CLUSTER_INSTANCE_STOP_START
            - CLUSTER_INSTANCE_RESYNC_REQUESTED
            - CLUSTER_INSTANCE_UPDATE_REQUESTED
            - SAMPLE_DATASET_LOAD_REQUESTED
            - TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL
            - TENANT_UPGRADE_TO_SERVERLESS_FAILED
            - NETWORK_PERMISSION_ENTRY_ADDED
            - NETWORK_PERMISSION_ENTRY_REMOVED
            - NETWORK_PERMISSION_ENTRY_UPDATED
            - CLUSTER_BLOCK_WRITE
            - CLUSTER_UNBLOCK_WRITE
            title: Atlas Audit Types
            type: string
          - enum:
            - MAINTENANCE_IN_ADVANCED
            - MAINTENANCE_AUTO_DEFERRED
            - MAINTENANCE_STARTED
            - MAINTENANCE_COMPLETED
            - MAINTENANCE_NO_LONGER_NEEDED
            title: Maintenance Window Audit Types
            type: string
          - enum:
            - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK
            - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK
            - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK
            title: x509 User Auth Event Types
            type: string
          - enum:
            - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK
            - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK
            title: Online Archive Event Types
            type: string
          - enum:
            - OUTSIDE_SERVERLESS_METRIC_THRESHOLD
            title: Serverless Event Types
            type: string
          - enum:
            - OUTSIDE_FLEX_METRIC_THRESHOLD
            title: Flex Metric Event Types
            type: string
          - enum:
            - JOINED_GROUP
            - REMOVED_FROM_GROUP
            - USER_ROLES_CHANGED_AUDIT
            title: User Event Types
            type: string
          - enum:
            - TAGS_MODIFIED
            - CLUSTER_TAGS_MODIFIED
            - GROUP_TAGS_MODIFIED
            title: Resource Event Types
            type: string
          - enum:
            - STREAM_PROCESSOR_STATE_IS_FAILED
            - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
            title: Stream Processor Event Types
            type: string
          - enum:
            - COMPUTE_AUTO_SCALE_INITIATED_BASE
            - COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS
            - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE
            - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS
            - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
            - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS
            - COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
            - COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS
            - DISK_AUTO_SCALE_INITIATED
            - DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL
            - DISK_AUTO_SCALE_OPLOG_FAIL
            - PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE
            - PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
            - PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
            - CLUSTER_AUTO_SHARDING_INITIATED
            - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_BASE
            - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_ANALYTICS
            title: Auto Scaling Audit Types
            type: string
          - enum:
            - CPS_DATA_PROTECTION_ENABLE_REQUESTED
            - CPS_DATA_PROTECTION_ENABLED
            - CPS_DATA_PROTECTION_UPDATE_REQUESTED
            - CPS_DATA_PROTECTION_UPDATED
            - CPS_DATA_PROTECTION_DISABLE_REQUESTED
            - CPS_DATA_PROTECTION_DISABLED
            - CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT
            title: Data Protection Event Types
            type: string
          - enum:
            - RESOURCE_POLICY_VIOLATED
            title: Atlas Resource Policy Audit Types
            type: string
          - enum:
            - HOST_DOWN
            - HOST_HAS_INDEX_SUGGESTIONS
            - HOST_MONGOT_CRASHING_OOM
            - HOST_MONGOT_STOP_REPLICATION
            - HOST_MONGOT_APPROACHING_STOP_REPLICATION
            - HOST_MONGOT_PAUSE_INITIAL_SYNC
            - HOST_SEARCH_NODE_INDEX_FAILED
            - HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN
            - HOST_NOT_ENOUGH_DISK_SPACE
            - SSH_KEY_NDS_HOST_ACCESS_REQUESTED
            - SSH_KEY_NDS_HOST_ACCESS_REFRESHED
            - PUSH_BASED_LOG_EXPORT_STOPPED
            - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
            - HOST_VERSION_BEHIND
            - VERSION_BEHIND
            - HOST_EXPOSED
            - HOST_SSL_CERTIFICATE_STALE
            - HOST_SECURITY_CHECKUP_NOT_MET
            - ALERT_HOST_SSH_SESSION_STARTED
            - PROFILER_CONFIGURED_TOO_WIDELY
            title: Host Event Types
            type: string
          readOnly: true
          type: object
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: Any Other Alerts
      type: object
    DefaultEventViewForNdsGroup:
      description: Other events which don't have extra details beside of basic one.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          description: Unique identifier of event type.
          oneOf:
          - enum:
            - AUTO_INDEXING_ENABLED
            - AUTO_INDEXING_DISABLED
            - AUTO_INDEXING_INDEX_BUILD_SUBMITTED
            - AUTO_INDEXING_SLOW_INDEX_BUILD
            - AUTO_INDEXING_STALLED_INDEX_BUILD
            - AUTO_INDEXING_FAILED_INDEX_BUILD
            - AUTO_INDEXING_COMPLETED_INDEX_BUILD
            - AUTO_INDEXING_STARTED_INDEX_BUILD
            title: Auto Indexing Event Types
            type: string
          - enum:
            - PEER_CREATED
            - PEER_DELETED
            - PEER_UPDATED
            title: AWS Peer Vpc Audit Types
            type: string
          - enum:
            - AZURE_PEER_CREATED
            - AZURE_PEER_UPDATED
            - AZURE_PEER_ACTIVE
            - AZURE_PEER_DELETED
            title: Azure Peer Network Audit Types
            type: string
          - enum:
            - CLUSTER_CONNECTION_GET_DATABASES
            - CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS
            - CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES
            - CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID
            - CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS
            - CLUSTER_CONNECTION_AGGREGATE
            - CLUSTER_CONNECTION_CREATE_COLLECTION
            - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES
            - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES
            - CLUSTER_CONNECTION_FIND_DOCUMENTS
            - CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA
            title: Cluster Connection Audit Types
            type: string
          - enum:
            - CPS_SNAPSHOT_STARTED
            - CPS_SNAPSHOT_SUCCESSFUL
            - CPS_SNAPSHOT_FAILED
            - CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY
            - CPS_SNAPSHOT_FALLBACK_SUCCESSFUL
            - CPS_SNAPSHOT_BEHIND
            - CPS_COPY_SNAPSHOT_STARTED
            - CPS_COPY_SNAPSHOT_FAILED
            - CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY
            - CPS_COPY_SNAPSHOT_SUCCESSFUL
            - CPS_PREV_SNAPSHOT_OLD
            - CPS_SNAPSHOT_FALLBACK_FAILED
            - CPS_RESTORE_SUCCESSFUL
            - CPS_EXPORT_SUCCESSFUL
            - CPS_RESTORE_FAILED
            - CPS_EXPORT_FAILED
            - CPS_COLLECTION_RESTORE_SUCCESSFUL
            - CPS_COLLECTION_RESTORE_FAILED
            - CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS
            - CPS_COLLECTION_RESTORE_CANCELED
            - CPS_AUTO_EXPORT_FAILED
            - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED
            - CPS_OPLOG_BEHIND
            - CPS_OPLOG_CAUGHT_UP
            title: Cps Backup Event Types
            type: string
          - enum:
            - CPS_DATA_PROTECTION_ENABLE_REQUESTED
            - CPS_DATA_PROTECTION_ENABLED
            - CPS_DATA_PROTECTION_UPDATE_REQUESTED
            - CPS_DATA_PROTECTION_UPDATED
            - CPS_DATA_PROTECTION_DISABLE_REQUESTED
            - CPS_DATA_PROTECTION_DISABLED
            - CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT
            title: CPS Backup Compliance Policy Event Types
            type: string
          - enum:
            - CPS_RESTORE_REQUESTED_AUDIT
            - CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT
            - CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT
            - CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT
            - CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT
            - CPS_SNAPSHOT_DELETED_AUDIT
            - CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT
            - CPS_SNAPSHOT_IN_PROGRESS_AUDIT
            - CPS_SNAPSHOT_COMPLETED_AUDIT
            - CPS_ON_DEMAND_SNAPSHOT_REQUESTED
            - CPS_OPLOG_CAUGHT_UP_AUDIT
            - CPS_OPLOG_BEHIND_AUDIT
            title: Disk Backup Event Types
            type: string
          - enum:
            - AWS_ENCRYPTION_KEY_ROTATED
            - AWS_ENCRYPTION_KEY_NEEDS_ROTATION
            - AZURE_ENCRYPTION_KEY_ROTATED
            - AZURE_ENCRYPTION_KEY_NEEDS_ROTATION
            - GCP_ENCRYPTION_KEY_ROTATED
            - GCP_ENCRYPTION_KEY_NEEDS_ROTATION
            - AWS_ENCRYPTION_KEY_VALID
            - AWS_ENCRYPTION_KEY_INVALID
            - AZURE_ENCRYPTION_KEY_VALID
            - AZURE_ENCRYPTION_KEY_INVALID
            - GCP_ENCRYPTION_KEY_VALID
            - GCP_ENCRYPTION_KEY_INVALID
            title: Encryption Event Types
            type: string
          - enum:
            - BUCKET_CREATED_AUDIT
            - BUCKET_DELETED_AUDIT
            title: Export Bucket Audit Types
            type: string
          - enum:
            - GCP_PEER_CREATED
            - GCP_PEER_DELETED
            - GCP_PEER_UPDATED
            - GCP_PEER_ACTIVE
            - GCP_PEER_INACTIVE
            title: GCP Peer Vpc Audit Types
            type: string
          - enum:
            - DATA_EXPLORER_ENABLED
            - DATA_EXPLORER_DISABLED
            - CREDIT_CARD_ADDED
            - CREDIT_CARD_UPDATED
            - GROUP_DELETED
            - GROUP_CREATED
            - GROUP_MOVED
            - GROUP_TEMPORARILY_ACTIVATED
            - GROUP_ACTIVATED
            - GROUP_LOCKED
            - GROUP_SUSPENDED
            - GROUP_FLUSHED
            - GROUP_NAME_CHANGED
            - GROUP_CHARTS_ACTIVATION_REQUESTED
            - GROUP_CHARTS_ACTIVATED
            - GROUP_CHARTS_UPGRADED
            - GROUP_CHARTS_RESET
            - GROUP_DEFAULT_ALERTS_SETTINGS_CHANGED
            title: Group Audit Types
            type: string
          - enum:
            - PAID_IN_FULL
            - DELINQUENT
            - ALL_USERS_HAVE_MULTI_FACTOR_AUTH
            - USERS_WITHOUT_MULTI_FACTOR_AUTH
            - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED
            - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED
            - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID
            - ENCRYPTION_AT_REST_CONFIG_IS_VALID
            - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING
            - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING
            - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED
            - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED
            - ACTIVE_LEGACY_TLS_CONNECTIONS
            - NO_ACTIVE_LEGACY_TLS_CONNECTIONS
            title: Group Event Types
            type: string
          - enum:
            - INTEGRATION_CONFIGURED
            - INTEGRATION_REMOVED
            title: Group Integration Event Types
            type: string
          - enum:
            - ROLLING_INDEX_FAILED_INDEX_BUILD
            - ROLLING_INDEX_SUCCESS_INDEX_BUILD
            - INDEX_FAILED_INDEX_BUILD
            - INDEX_SUCCESS_INDEX_BUILD
            title: Index Build Audit Types
            type: string
          - enum:
            - DB_CHECK_UPDATED
            - CLUSTER_SAMPLED_FOR_DB_CHECK
            - DB_CHECK_SCHEDULED_FOR_CLUSTER
            - DB_CHECK_DEFERRED_FOR_CLUSTER
            - CLUSTER_OPTED_OUT_OF_DB_CHECK
            title: DB Check Audit Types
            type: string
          - enum:
            - CLUSTER_SAMPLED_FOR_DATA_VALIDATION
            - DATA_VALIDATION_SUBMITTED_FOR_CLUSTER
            - CLUSTER_OPTED_OUT_OF_DATA_VALIDATION
            - REPLICA_SET_SAMPLED_FOR_INTER_NODE_DATA_VALIDATION
            - REPLICA_SET_OPTED_OUT_OF_INTER_NODE_DATA_VALIDATION
            - INTER_NODE_DATA_VALIDATION_SUBMITTED_FOR_REPLICA_SET
            title: Data Validation Audit Types
            type: string
          - enum:
            - MAINTENANCE_IN_ADVANCED
            - MAINTENANCE_AUTO_DEFERRED
            - MAINTENANCE_STARTED
            - MAINTENANCE_COMPLETED
            - MAINTENANCE_NO_LONGER_NEEDED
            title: Maintenance Window Audit Types
            type: string
          - enum:
            - SERVERLESS_AUTO_SCALING_INITIATED
            - SERVERLESS_VERTICAL_SCALING_INITIATED
            - SERVERLESS_HORIZONTAL_SCALING_INITIATED
            - SERVERLESS_MTM_DRAIN_REQUESTED
            - SERVERLESS_MTM_DRAIN_INITIATED
            - SERVERLESS_MTM_DRAIN_COMPLETED
            - SERVERLESS_MTM_DRAIN_STOPPED
            title: Serverless Auto Scaling Audit Types
            type: string
          - enum:
            - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED
            - TENANT_ENDPOINT_SERVICE_CREATED
            - TENANT_ENDPOINT_SERVICE_AVAILABLE
            - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED
            - TENANT_ENDPOINT_SERVICE_DELETED
            - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED
            - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED
            title: Tenant Endpoint Service Deployment Audit Types
            type: string
          - enum:
            - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED
            - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK
            - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED
            - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK
            - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED
            - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK
            title: x509 User Auth Event Types
            type: string
          - enum:
            - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK
            - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED
            - ONLINE_ARCHIVE_UP_TO_DATE
            - ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED
            - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK
            title: Online Archive Event Types
            type: string
          - enum:
            - CROSS_REGION_SUPPORTED_REGION_MODIFIED
            - ENDPOINT_SERVICE_CREATED
            - ENDPOINT_SERVICE_DELETED
            - INTERFACE_ENDPOINT_CREATED
            - INTERFACE_ENDPOINT_DELETED
            - INTERFACE_ENDPOINT_PATCHED
            - INTERFACE_ENDPOINT_RETRIED
            title: Private Link Audit Types
            type: string
          - enum:
            - PROACTIVE_OPERATION_EVENT_LOGGED
            title: Proactive Operation Event Types
            type: string
          - enum:
            - SEARCH_DEPLOYMENT_CREATED
            - SEARCH_DEPLOYMENT_UPDATED
            - SEARCH_DEPLOYMENT_DELETED
            title: Search Deployment Audit Types
            type: string
          - enum:
            - SERVERLESS_DEPLOYMENT_CREATED
            - SERVERLESS_DEPLOYMENT_DELETED
            - SERVERLESS_DEPLOYMENT_UPDATED
            - SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED
            - SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED
            - SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED
            - SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED
            - SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED
            title: Serverless Deployment Audit Types
            type: string
          - enum:
            - INSIDE_SERVERLESS_METRIC_THRESHOLD
            - OUTSIDE_SERVERLESS_METRIC_THRESHOLD
            title: Serverless Event Types
            type: string
          - enum:
            - INSIDE_FLEX_METRIC_THRESHOLD
            - OUTSIDE_FLEX_METRIC_THRESHOLD
            title: Flex Metric Event Types
            type: string
          - enum:
            - SETUP_SERVERLESS_INITIATED
            title: Setup Serverless Audit Types
            type: string
          - enum:
            - MAX_PROCESSOR_COUNT_REACHED
            title: Streams Event Types
            type: string
          - enum:
            - STREAM_PROCESSOR_STATE_IS_FAILED
            - INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
            - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
            title: Stream Processor Event Types
            type: string
          - enum:
            - CASE_CREATED
            title: Support Case Event Types
            type: string
          - enum:
            - SUPPORT_EMAILS_SENT_SUCCESSFULLY
            - SUPPORT_EMAILS_SENT_FAILURE
            title: Support Event Types
            type: string
          - enum:
            - TENANT_SNAPSHOT_STARTED_AUDIT
            - TENANT_SNAPSHOT_COMPLETED_AUDIT
            - TENANT_SNAPSHOT_DELETED_AUDIT
            - TENANT_RESTORE_REQUESTED_AUDIT
            - TENANT_RESTORE_COMPLETED_AUDIT
            - TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT
            title: Tenant Backup Event Types
            type: string
          - enum:
            - CLUSTER_FCV_FIXED
            - CLUSTER_FCV_UNFIXED
            - CLUSTER_FCV_EXPIRATION_DATE_UPDATED
            - CLUSTER_FCV_DOWNGRADED
            - CLUSTER_BINARY_VERSION_DOWNGRADED
            - CLUSTER_BINARY_VERSION_UPGRADED
            - CLUSTER_OS_FIXED
            - CLUSTER_OS_UNFIXED
            title: Version Audit Types
            type: string
          - enum:
            - EMPLOYEE_DOWNLOADED_CLUSTER_LOGS
            title: Access Event Types
            type: string
          - enum:
            - QUERY_SHAPE_BLOCKED
            - QUERY_SHAPE_UNBLOCKED
            title: Query Shape Event Types
            type: string
          - enum:
            - SHARD_KEY_ANALYSIS_STARTED
            - SHARD_KEY_ANALYSIS_FINISHED
            - QUERY_SAMPLING_STARTED
            - QUERY_SAMPLING_STOPPED
            title: Shard Key Advisor Event Types
            type: string
          - enum:
            - MONGOTUNE_INFO
            - MONGOTUNE_ALERT
            title: Mongotune Event Types
            type: string
          - enum:
            - AI_MODELS_API_KEY_CREATED
            - AI_MODELS_API_KEY_DELETED
            title: Ai Models Event Types
            type: string
          type: object
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Any Other Events
      type: object
    DefaultEventViewForOrg:
      description: Other events which don't have extra details beside of basic one.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          description: Unique identifier of event type.
          oneOf:
          - enum:
            - FEDERATION_SETTINGS_CREATED
            - FEDERATION_SETTINGS_DELETED
            - FEDERATION_SETTINGS_UPDATED
            - IDENTITY_PROVIDER_CREATED
            - IDENTITY_PROVIDER_UPDATED
            - IDENTITY_PROVIDER_DELETED
            - IDENTITY_PROVIDER_ACTIVATED
            - OIDC_IDENTITY_PROVIDER_UPDATED
            - IDENTITY_PROVIDER_DEACTIVATED
            - IDENTITY_PROVIDER_JWKS_REVOKED
            - OIDC_IDENTITY_PROVIDER_ENABLED
            - OIDC_IDENTITY_PROVIDER_DISABLED
            - DOMAINS_ASSOCIATED
            - DOMAIN_CREATED
            - DOMAIN_DELETED
            - DOMAIN_VERIFIED
            - ORG_SETTINGS_CONFIGURED
            - ORG_SETTINGS_UPDATED
            - ORG_SETTINGS_DELETED
            - RESTRICT_ORG_MEMBERSHIP_ENABLED
            - RESTRICT_ORG_MEMBERSHIP_DISABLED
            - ROLE_MAPPING_CREATED
            - ROLE_MAPPING_UPDATED
            - ROLE_MAPPING_DELETED
            title: Federation Settings Event Types
            type: string
          - enum:
            - GROUP_DELETED
            - GROUP_CREATED
            - GROUP_MOVED
            title: Group Audit Types
            type: string
          - enum:
            - MLAB_MIGRATION_COMPLETED
            - MLAB_MIGRATION_TARGET_CLUSTER_CREATED
            - MLAB_MIGRATION_DATABASE_USERS_IMPORTED
            - MLAB_MIGRATION_IP_WHITELIST_IMPORTED
            - MLAB_MIGRATION_TARGET_CLUSTER_SET
            - MLAB_MIGRATION_DATABASE_RENAMED
            - MLAB_MIGRATION_LIVE_IMPORT_STARTED
            - MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER
            - MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE
            - MLAB_MIGRATION_LIVE_IMPORT_ERROR
            - MLAB_MIGRATION_LIVE_IMPORT_CANCELLED
            - MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED
            - MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED
            - MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED
            - MLAB_MIGRATION_SUPPORT_PLAN_SELECTED
            - MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT
            title: Mlab Migration Audit Types
            type: string
          - enum:
            - AWS_SELF_SERVE_ACCOUNT_LINKED
            - AWS_SELF_SERVE_ACCOUNT_LINK_PENDING
            - AWS_SELF_SERVE_ACCOUNT_CANCELLED
            - AWS_SELF_SERVE_ACCOUNT_LINK_FAILED
            - GCP_SELF_SERVE_ACCOUNT_LINK_PENDING
            - GCP_SELF_SERVE_ACCOUNT_LINK_FAILED
            - AZURE_SELF_SERVE_ACCOUNT_LINKED
            - AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING
            - AZURE_SELF_SERVE_ACCOUNT_CANCELLED
            - AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED
            - GCP_SELF_SERVE_ACCOUNT_LINKED
            - GCP_SELF_SERVE_ACCOUNT_CANCELLED
            - VERCEL_SELF_SERVE_ACCOUNT_LINKED
            - VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING
            - VERCEL_SELF_SERVE_ACCOUNT_CANCELLED
            - VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED
            - VERCEL_INVOICE_CREATED
            - VERCEL_INVOICE_NOT_PAID
            - VERCEL_INVOICE_OVERDUE
            - VERCEL_INVOICE_PAID
            - VERCEL_INVOICE_REFUNDED
            title: Partner Event Types
            type: string
          - enum:
            - SUPPORT_EMAILS_SENT_SUCCESSFULLY
            - SUPPORT_EMAILS_SENT_FAILURE
            title: Support Event Types
            type: string
          - enum:
            - AI_MODELS_USAGE_TIER_UPDATED
            title: Ai Models Event Types
            type: string
          type: object
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Any Other Events
      type: object
    DefaultLimit:
      description: Details of user managed limits.
      properties:
        currentUsage:
          description: Amount that indicates the current usage of the limit.
          format: int64
          readOnly: true
          type: integer
        defaultLimit:
          description: Default value of the limit.
          format: int64
          readOnly: true
          type: integer
        maximumLimit:
          description: Maximum value of the limit.
          format: int64
          readOnly: true
          type: integer
        name:
          description: Human-readable label that identifies the user-managed limit
            to modify.
          readOnly: true
          type: string
        value:
          description: Amount to set the limit to.
          format: int64
          type: integer
      required:
      - name
      - value
      title: Default Limit
      type: object
    DefaultScheduleView:
      allOf:
      - "$ref": "#/components/schemas/OnlineArchiveSchedule"
      required:
      - type
      type: object
    DeleteCopiedBackups20240805:
      description: Deleted copy setting whose backup copies need to also be deleted.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider for
            the deleted copy setting whose backup copies you want to delete.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
          writeOnly: true
        regionName:
          description: Target region for the deleted copy setting whose backup copies
            you want to delete. Please supply the 'Atlas Region'.
          externalDocs:
            description: Cloud Provider Regions
            url: https://www.mongodb.com/docs/atlas/reference/cloud-providers/
          type: string
          writeOnly: true
        zoneId:
          description: Unique 24-hexadecimal digit string that identifies the zone
            in a cluster. For global clusters, there can be multiple zones to choose
            from. For sharded clusters and replica set clusters, there is only one
            zone in the cluster. To find the Zone Id, do a GET request to Return One
            Cluster from One Project and consult the `replicationSpecs` array.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Return One Cluster from One Project
            url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
      type: object
      writeOnly: true
    DeprecatedStreamProcessorMetricThreshold:
      deprecated: true
      description: 'Threshold value that triggers an alert. Deprecated: use `metricThreshold`
        instead.'
      discriminator:
        mapping:
          STREAM_PROCESSOR_CHANGE_STREAM_LAG: "#/components/schemas/TimeMetricThresholdView"
          STREAM_PROCESSOR_DLQ_MESSAGE_COUNT: "#/components/schemas/DLQRawMetricThresholdView"
          STREAM_PROCESSOR_KAFKA_LAG: "#/components/schemas/KafkaRawMetricThresholdView"
          STREAM_PROCESSOR_OUTPUT_MESSAGE_COUNT: "#/components/schemas/RawMetricThresholdView"
        propertyName: metricName
      oneOf:
      - "$ref": "#/components/schemas/KafkaRawMetricThresholdView"
      - "$ref": "#/components/schemas/TimeMetricThresholdView"
      - "$ref": "#/components/schemas/DLQRawMetricThresholdView"
      - "$ref": "#/components/schemas/RawMetricThresholdView"
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      required:
      - metricName
      type: object
    Destination:
      description: Document that describes the destination of the migration.
      properties:
        clusterName:
          description: Label that identifies the destination cluster.
          minLength: 1
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the destination
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        hostnameSchemaType:
          description: The network type to use between the migration host and the
            destination cluster.
          enum:
          - PUBLIC
          - PRIVATE_LINK
          - VPC_PEERING
          minLength: 1
          type: string
        privateLinkId:
          description: Represents the endpoint to use when the host schema type is
            `PRIVATE_LINK`.
          type: string
      required:
      - clusterName
      - groupId
      - hostnameSchemaType
      type: object
    DiskBackupApiPolicyItem:
      description: Specifications for one policy.
      properties:
        frequencyInterval:
          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
          format: int32
          type: integer
        frequencyType:
          description: Human-readable label that identifies the frequency type associated
            with the backup policy.
          enum:
          - daily
          - hourly
          - weekly
          - monthly
          - yearly
          - ondemand
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this backup
            policy item.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        retentionUnit:
          description: Unit of time in which MongoDB Cloud measures Snapshot retention.
          enum:
          - days
          - weeks
          - months
          - years
          type: string
        retentionValue:
          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.
          format: int32
          type: integer
      required:
      - frequencyInterval
      - frequencyType
      - retentionUnit
      - retentionValue
      type: object
    DiskBackupCopyPolicyItem:
      description: Specifications for one copy policy item.
      discriminator:
        mapping:
          daily: "#/components/schemas/DiskBackupTimeBasedCopyPolicyItem"
          hourly: "#/components/schemas/DiskBackupTimeBasedCopyPolicyItem"
          monthly: "#/components/schemas/DiskBackupTimeBasedCopyPolicyItem"
          ondemand: "#/components/schemas/DiskBackupOnDemandCopyPolicyItem"
          weekly: "#/components/schemas/DiskBackupTimeBasedCopyPolicyItem"
          yearly: "#/components/schemas/DiskBackupTimeBasedCopyPolicyItem"
        propertyName: frequencyType
      oneOf:
      - "$ref": "#/components/schemas/DiskBackupOnDemandCopyPolicyItem"
      - "$ref": "#/components/schemas/DiskBackupTimeBasedCopyPolicyItem"
      properties:
        frequencyType:
          description: Human-readable label that identifies the frequency type associated
            with the copy policy.
          enum:
          - daily
          - hourly
          - weekly
          - monthly
          - yearly
          - ondemand
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this copy
            policy item.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      required:
      - frequencyType
      type: object
    DiskBackupCopySetting20240805:
      description: Copy setting item in the desired backup policy.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider that
            stores the snapshot copy.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        copyPolicyItems:
          description: List that contains a document for each copy policy item. Allowed
            only when `copyPolicyItemsEnabled` is true. Responses omit this field
            when `copyPolicyItemsEnabled` is false or omitted.
          items:
            "$ref": "#/components/schemas/DiskBackupCopyPolicyItem"
          maxItems: 6
          type: array
        frequencies:
          deprecated: true
          description: 'Deprecated: use `copyPolicyItems`, which defines which snapshots
            to copy and their retention. Allowed only when `copyPolicyItemsEnabled`
            is false or omitted. Responses omit this field when `copyPolicyItemsEnabled`
            is true.'
          items:
            enum:
            - HOURLY
            - DAILY
            - WEEKLY
            - MONTHLY
            - YEARLY
            - ON_DEMAND
            type: string
          maxItems: 6
          type: array
        lastNumberOfSnapshots:
          description: Number of most recent snapshots to copy to the target region.
            If specified, Atlas copies this number of the most recent snapshots rather
            than using a frequency-based or policy-based copy schedule. This field
            is mutually exclusive with `frequencies` and `copyPolicyItems`.
          format: int32
          maximum: 500
          minimum: 1
          type: integer
        regionName:
          description: Target region to copy snapshots belonging to `zoneId`. Please
            supply the 'Atlas Region'.
          externalDocs:
            description: Cloud Provider Regions
            url: https://www.mongodb.com/docs/atlas/reference/cloud-providers/
          type: string
        shouldCopyOplogs:
          description: Flag that indicates whether to copy the oplogs to the target
            region. You can use the oplogs to perform point-in-time restores.
          type: boolean
        zoneId:
          description: Unique 24-hexadecimal digit string that identifies the zone
            in a cluster. For global clusters, there can be multiple zones to choose
            from. For sharded clusters and replica set clusters, there is only one
            zone in the cluster. To find the Zone Id, do a GET request to Return One
            Cluster from One Project and consult the `replicationSpecs` array.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Return One Cluster From One Project
            url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster
          pattern: "^([a-f0-9]{24})$"
          type: string
      required:
      - zoneId
      type: object
    DiskBackupExportJob:
      properties:
        components:
          description: Information on the export job for each replica set in the sharded
            cluster.
          items:
            "$ref": "#/components/schemas/DiskBackupExportMember"
          readOnly: true
          type: array
        createdAt:
          description: Date and time when a user or Atlas created the Export Job.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        customData:
          description: Collection of key-value pairs that represent custom data for
            the metadata file that MongoDB Cloud uploads when the Export Job finishes.
          items:
            "$ref": "#/components/schemas/BackupLabel"
          type: array
        exportBucketId:
          description: Unique 24-hexadecimal character string that identifies the
            Export Bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        exportStatus:
          "$ref": "#/components/schemas/ExportStatus"
        finishedAt:
          description: Date and time when this Export Job completed. MongoDB Cloud
            represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            restore job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        prefix:
          description: Prefix used for all blob storage objects uploaded as part of
            the Export Job.
          pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}"
          readOnly: true
          type: string
        snapshotId:
          description: Unique 24-hexadecimal character string that identifies the
            snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        state:
          description: State of the Export Job.
          enum:
          - Cancelled
          - Failed
          - InProgress
          - Queued
          - Successful
          readOnly: true
          type: string
        stateReason:
          "$ref": "#/components/schemas/StateReason"
      required:
      - exportBucketId
      type: object
    DiskBackupExportJobRequest:
      properties:
        customData:
          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.
          items:
            "$ref": "#/components/schemas/BackupLabel"
          type: array
        exportBucketId:
          description: Unique 24-hexadecimal character string that identifies the
            Export Bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        snapshotId:
          description: Unique 24-hexadecimal character string that identifies the
            Cloud Backup Snapshot to export.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
      required:
      - exportBucketId
      - snapshotId
      type: object
    DiskBackupExportMember:
      properties:
        exportId:
          description: Unique 24-hexadecimal character string that identifies the
            the Cloud Backup snapshot export job for each shard in a sharded cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Human-readable label that identifies the replica set on the
            sharded cluster.
          readOnly: true
          type: string
      type: object
    DiskBackupOnDemandCopyPolicyItem:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupCopyPolicyItem"
      description: Specifications for one on-demand copy policy item.
      required:
      - frequencyType
      type: object
    DiskBackupOnDemandSnapshotRequest:
      properties:
        description:
          description: 'Human-readable phrase or sentence that explains the purpose
            of the snapshot. The resource returns this parameter when `"status" :
            "onDemand"`.'
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        retentionInDays:
          description: Number of days that MongoDB Cloud should retain the on-demand
            snapshot. Must be at least **1**.
          format: int32
          minimum: 1
          type: integer
      type: object
    DiskBackupReplicaSet:
      description: Details of the replica set snapshot that MongoDB Cloud created.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        copyRegions:
          description: List that identifies the regions to which MongoDB Cloud copies
            the snapshot.
          items:
            type: string
          readOnly: true
          type: array
        createdAt:
          description: Date and time when MongoDB Cloud took the snapshot. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: 'Human-readable phrase or sentence that explains the purpose
            of the snapshot. The resource returns this parameter when `"status": "onDemand"`.'
          readOnly: true
          type: string
        expiresAt:
          description: Date and time when MongoDB Cloud deletes the snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        frequencyType:
          description: Human-readable label that identifies how often this snapshot
            triggers.
          enum:
          - hourly
          - daily
          - weekly
          - monthly
          - yearly
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        masterKeyUUID:
          description: 'Unique string that identifies the Amazon Web Services (AWS)
            Key Management Service (KMS) Customer Master Key (CMK) used to encrypt
            the snapshot. The resource returns this value when `"encryptionEnabled"
            : true`.'
          format: uuid
          readOnly: true
          type: string
        mongodVersion:
          description: Version of the MongoDB host that this snapshot backs up.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        policyItems:
          description: List that contains unique identifiers for the policy items.
          items:
            description: Unique 24-hexadecimal digit string that identifies one policy
              item.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          readOnly: true
          type: array
        replicaSetName:
          description: 'Human-readable label that identifies the replica set from
            which MongoDB Cloud took this snapshot. The resource returns this parameter
            when `"type": "replicaSet"`.'
          readOnly: true
          type: string
        snapshotType:
          description: Human-readable label that identifies when this snapshot triggers.
          enum:
          - onDemand
          - scheduled
          - fallback
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the stage of the backup
            process for this snapshot.
          enum:
          - queued
          - inProgress
          - completed
          - failed
          readOnly: true
          type: string
        storageSizeBytes:
          description: Number of bytes taken to store the backup at time of snapshot.
          format: int64
          readOnly: true
          type: integer
        type:
          description: Human-readable label that categorizes the cluster as a replica
            set or sharded cluster.
          enum:
          - replicaSet
          - shardedCluster
          readOnly: true
          type: string
      title: Replica Set Snapshot
      type: object
    DiskBackupRestoreMember:
      properties:
        downloadUrl:
          description: 'One Uniform Resource Locator that points to the compressed
            snapshot files for manual download. MongoDB Cloud returns this parameter
            when `"deliveryType" : "download"`.'
          readOnly: true
          type: string
        privateDownloadDeliveryUrls:
          description: 'One or more Uniform Resource Locators (URLs) that point to
            the compressed snapshot files for manual download and the corresponding
            private endpoint(s). MongoDB Cloud returns this parameter when `"deliveryType"
            : "download"` and the download can be performed privately.'
          items:
            "$ref": "#/components/schemas/ApiPrivateDownloadDeliveryUrl"
          readOnly: true
          type: array
        replicaSetName:
          description: Human-readable label that identifies the replica set on the
            sharded cluster.
          readOnly: true
          type: string
      type: object
    DiskBackupShardedClusterSnapshot:
      description: Details of the sharded cluster snapshot that MongoDB Cloud created.
      properties:
        configServerType:
          description: Describes a sharded cluster's config server type.
          enum:
          - EMBEDDED
          - DEDICATED
          readOnly: true
          type: string
        createdAt:
          description: Date and time when MongoDB Cloud took the snapshot. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: 'Human-readable phrase or sentence that explains the purpose
            of the snapshot. The resource returns this parameter when `"status": "onDemand"`.'
          readOnly: true
          type: string
        expiresAt:
          description: Date and time when MongoDB Cloud deletes the snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        frequencyType:
          description: Human-readable label that identifies how often this snapshot
            triggers.
          enum:
          - hourly
          - daily
          - weekly
          - monthly
          - yearly
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        masterKeyUUID:
          description: 'Unique string that identifies the Amazon Web Services (AWS)
            Key Management Service (KMS) Customer Master Key (CMK) used to encrypt
            the snapshot. The resource returns this value when `"encryptionEnabled"
            : true`.'
          format: uuid
          readOnly: true
          type: string
        members:
          description: 'List that includes the snapshots and the cloud provider that
            stores the snapshots. The resource returns this parameter when `"type"
            : "SHARDED_CLUSTER"`.'
          items:
            "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshotMember"
          readOnly: true
          type: array
        mongodVersion:
          description: Version of the MongoDB host that this snapshot backs up.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        policyItems:
          description: List that contains unique identifiers for the policy items.
          items:
            description: Unique 24-hexadecimal digit string that identifies one policy
              item.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          readOnly: true
          type: array
        snapshotIds:
          description: 'List that contains the unique identifiers of the snapshots
            created for the shards and config host for a sharded cluster. The resource
            returns this parameter when `"type": "SHARDED_CLUSTER"`. These identifiers
            should match the ones specified in the **members[n].id** parameters. This
            allows you to map a snapshot to its shard or config host name.'
          items:
            description: Unique 24-hexadecimal digit string that identifies the snapshot
              for part of the sharded cluster.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          readOnly: true
          type: array
        snapshotType:
          description: Human-readable label that identifies when this snapshot triggers.
          enum:
          - onDemand
          - scheduled
          - fallback
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the stage of the backup
            process for this snapshot.
          enum:
          - queued
          - inProgress
          - completed
          - failed
          readOnly: true
          type: string
        storageSizeBytes:
          description: Number of bytes taken to store the backup at time of snapshot.
          format: int64
          readOnly: true
          type: integer
        type:
          description: Human-readable label that categorizes the cluster as a replica
            set or sharded cluster.
          enum:
          - replicaSet
          - shardedCluster
          readOnly: true
          type: string
      title: Sharded Cluster Snapshot
      type: object
    DiskBackupShardedClusterSnapshotMember:
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Human-readable label that identifies the shard or config host
            from which MongoDB Cloud took this snapshot.
          readOnly: true
          type: string
      required:
      - cloudProvider
      - id
      - replicaSetName
      type: object
    DiskBackupSnapshot:
      discriminator:
        mapping:
          replicaSet: "#/components/schemas/DiskBackupReplicaSet"
          shardedCluster: "#/components/schemas/DiskBackupShardedClusterSnapshot"
        propertyName: type
      properties:
        createdAt:
          description: Date and time when MongoDB Cloud took the snapshot. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: 'Human-readable phrase or sentence that explains the purpose
            of the snapshot. The resource returns this parameter when `"status": "onDemand"`.'
          readOnly: true
          type: string
        expiresAt:
          description: Date and time when MongoDB Cloud deletes the snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        frequencyType:
          description: Human-readable label that identifies how often this snapshot
            triggers.
          enum:
          - hourly
          - daily
          - weekly
          - monthly
          - yearly
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        masterKeyUUID:
          description: 'Unique string that identifies the Amazon Web Services (AWS)
            Key Management Service (KMS) Customer Master Key (CMK) used to encrypt
            the snapshot. The resource returns this value when `"encryptionEnabled"
            : true`.'
          format: uuid
          readOnly: true
          type: string
        mongodVersion:
          description: Version of the MongoDB host that this snapshot backs up.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        policyItems:
          description: List that contains unique identifiers for the policy items.
          items:
            description: Unique 24-hexadecimal digit string that identifies one policy
              item.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          readOnly: true
          type: array
        snapshotType:
          description: Human-readable label that identifies when this snapshot triggers.
          enum:
          - onDemand
          - scheduled
          - fallback
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the stage of the backup
            process for this snapshot.
          enum:
          - queued
          - inProgress
          - completed
          - failed
          readOnly: true
          type: string
        storageSizeBytes:
          description: Number of bytes taken to store the backup at time of snapshot.
          format: int64
          readOnly: true
          type: integer
        type:
          description: Human-readable label that categorizes the cluster as a replica
            set or sharded cluster.
          enum:
          - replicaSet
          - shardedCluster
          readOnly: true
          type: string
      type: object
    DiskBackupSnapshotAWSExportBucketRequest:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketRequest"
      - properties:
          bucketName:
            description: Human-readable label that identifies the AWS S3 Bucket that
              the role is authorized to export to.
            example: export-bucket
            maxLength: 63
            minLength: 3
            type: string
          iamRoleId:
            description: Unique 24-hexadecimal character string that identifies the
              Unified AWS Access role ID that MongoDB Cloud uses to access the AWS
              S3 bucket.
            example: 32b6e34b3d91647abb20e7b8
            externalDocs:
              description: Unified AWS Access role ID
              url: https://www.mongodb.com/docs/atlas/security/set-up-unified-aws-access/
            pattern: "^([a-f0-9]{24})$"
            type: string
          requirePrivateNetworking:
            description: Indicates whether to do exports over PrivateLink as opposed
              to public IPs. Defaults to False.
            type: boolean
        type: object
      required:
      - bucketName
      - cloudProvider
      - iamRoleId
      type: object
    DiskBackupSnapshotAWSExportBucketResponse:
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies the
            Export Bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        bucketName:
          description: The name of the AWS S3 Bucket, Azure Storage Container, or
            Google Cloud Storage Bucket that Snapshots are exported to.
          example: export-bucket
          maxLength: 63
          minLength: 3
          type: string
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        iamRoleId:
          description: Unique 24-hexadecimal character string that identifies the
            Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3
            bucket.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Unified AWS Access role ID
            url: https://www.mongodb.com/docs/atlas/security/set-up-unified-aws-access/
          pattern: "^([a-f0-9]{24})$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        region:
          description: AWS region for the export bucket. This is set by Atlas and
            is never user-supplied.
          example: us-east-1
          readOnly: true
          type: string
        requirePrivateNetworking:
          description: Indicates whether to use private link. User supplied.
          type: boolean
      required:
      - _id
      - bucketName
      - cloudProvider
      - iamRoleId
      type: object
    DiskBackupSnapshotAzureExportBucketRequest:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketRequest"
      - properties:
          bucketName:
            description: The name of the Azure Storage Container to export to. This
              can be omitted and computed from the `serviceUrl` if the `serviceUrl`
              includes a Azure Storage Container name. For example a `serviceUrl`
              of `https://examplestorageaccount.blob.core.windows.net/exportcontainer`
              will yield a computed `bucketName` of `exportcontainer`. If the `serviceUrl`
              does not include a Container name, this field is required.
            example: exportcontainer
            maxLength: 63
            minLength: 3
            type: string
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the Azure
              Cloud Provider Access Role that MongoDB Cloud uses to access the Azure
              Blob Storage Container.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          serviceUrl:
            description: 'URL of the Azure Storage Account to export to. For example:
              `https://examplestorageaccount.blob.core.windows.net/exportcontainer`.
              Only standard endpoints (with `blob.core.windows.net`) are supported.'
            example: https://examplestorageaccount.blob.core.windows.net/exportcontainer
            maxLength: 2048
            minLength: 33
            type: string
          tenantId:
            deprecated: true
            description: 'UUID that identifies the Azure Active Directory Tenant ID.
              Deprecated: this field is ignored; the `tenantId` of the Cloud Provider
              Access role (from `roleId`) is used.'
            format: uuid
            type: string
        type: object
      required:
      - cloudProvider
      - roleId
      - serviceUrl
      type: object
    DiskBackupSnapshotAzureExportBucketResponse:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketResponse"
      - properties:
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the Azure
              Cloud Provider Access Role that MongoDB Cloud uses to access the Azure
              Blob Storage Container.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          serviceUrl:
            description: URL of the Azure Storage Account to export to. Only standard
              endpoints (with `blob.core.windows.net`) are supported.
            example: https://examplestorageaccount.blob.core.windows.net/exportcontainer
            maxLength: 2048
            minLength: 33
            type: string
          tenantId:
            description: UUID that identifies the Azure Active Directory Tenant ID
              used during exports.
            format: uuid
            type: string
        type: object
      required:
      - _id
      - bucketName
      - cloudProvider
      - roleId
      - serviceUrl
      - tenantId
      type: object
    DiskBackupSnapshotExportBucketRequest:
      description: Disk backup snapshot Export Bucket Request.
      discriminator:
        mapping:
          AWS: "#/components/schemas/DiskBackupSnapshotAWSExportBucketRequest"
          AZURE: "#/components/schemas/DiskBackupSnapshotAzureExportBucketRequest"
          GCP: "#/components/schemas/DiskBackupSnapshotGCPExportBucketRequest"
        propertyName: cloudProvider
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      required:
      - cloudProvider
      type: object
    DiskBackupSnapshotExportBucketResponse:
      description: Disk backup snapshot Export Bucket.
      discriminator:
        mapping:
          AWS: "#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse"
          AZURE: "#/components/schemas/DiskBackupSnapshotAzureExportBucketResponse"
          GCP: "#/components/schemas/DiskBackupSnapshotGCPExportBucketResponse"
        propertyName: cloudProvider
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies the
            Export Bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        bucketName:
          description: The name of the AWS S3 Bucket, Azure Storage Container, or
            Google Cloud Storage Bucket that Snapshots are exported to.
          example: export-bucket
          maxLength: 63
          minLength: 3
          type: string
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      required:
      - _id
      - bucketName
      - cloudProvider
      type: object
    DiskBackupSnapshotGCPExportBucketRequest:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketRequest"
      - properties:
          bucketName:
            description: Human-readable label that identifies the Google Cloud Storage
              Bucket that the role is authorized to export to.
            example: export-bucket
            maxLength: 63
            minLength: 3
            type: string
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the GCP
              Cloud Provider Access Role that MongoDB Cloud uses to access the Google
              Cloud Storage Bucket.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
        type: object
      required:
      - bucketName
      - cloudProvider
      - roleId
      type: object
    DiskBackupSnapshotGCPExportBucketResponse:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketResponse"
      - properties:
          roleId:
            description: Unique 24-hexadecimal digit string that identifies the GCP
              Cloud Provider Access Role that MongoDB Cloud uses to access the Google
              Cloud Storage Bucket.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
        type: object
      required:
      - _id
      - bucketName
      - cloudProvider
      - roleId
      type: object
    DiskBackupSnapshotRestoreJob:
      properties:
        cancelled:
          description: Flag that indicates whether someone canceled this restore job.
          readOnly: true
          type: boolean
        components:
          description: Information on the restore job for each replica set in the
            sharded cluster.
          items:
            "$ref": "#/components/schemas/DiskBackupRestoreMember"
          readOnly: true
          type: array
        deliveryType:
          description: Human-readable label that categorizes the restore job to create.
          enum:
          - automated
          - download
          - pointInTime
          type: string
        deliveryUrl:
          description: 'One or more Uniform Resource Locators (URLs) that point to
            the compressed snapshot files for manual download. MongoDB Cloud returns
            this parameter when `"deliveryType" : "download"`.'
          items:
            description: One Uniform Resource Locator that points to the compressed
              snapshot files for manual download.
            type: string
          readOnly: true
          type: array
        desiredTimestamp:
          "$ref": "#/components/schemas/ApiBSONTimestampView"
        expired:
          description: Flag that indicates whether the restore job expired.
          readOnly: true
          type: boolean
        expiresAt:
          description: Date and time when the restore job expires. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        failed:
          description: Flag that indicates whether the restore job failed.
          readOnly: true
          type: boolean
        finishedAt:
          description: Date and time when the restore job completed. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            restore job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        oplogInc:
          description: 'Oplog operation number from which you want to restore this
            snapshot. This number represents the second part of an Oplog timestamp.
            The resource returns this parameter when `"deliveryType" : "pointInTime"`
            and `oplogTs` exceeds `0`.'
          example: 1
          format: int32
          minimum: 1
          type: integer
        oplogTs:
          description: 'Date and time from which you want to restore this snapshot.
            This parameter expresses this timestamp in the number of seconds that
            have elapsed since the UNIX epoch. This number represents the first part
            of an Oplog timestamp. The resource returns this parameter when `"deliveryType"
            : "pointInTime"` and `oplogTs` exceeds `0`.'
          format: int32
          minimum: 1199145600
          type: integer
        pointInTimeUTCSeconds:
          description: 'Date and time from which MongoDB Cloud restored this snapshot.
            This parameter expresses this timestamp in the number of seconds that
            have elapsed since the UNIX epoch. The resource returns this parameter
            when `"deliveryType" : "pointInTime"` and `pointInTimeUTCSeconds` exceeds
            `0`.'
          format: int32
          minimum: 1199145600
          type: integer
        privateDownloadDeliveryUrls:
          description: 'One or more Uniform Resource Locators (URLs) that point to
            the compressed snapshot files for manual download and the corresponding
            private endpoint(s). MongoDB Cloud returns this parameter when `"deliveryType"
            : "download"` and the download can be performed privately.'
          items:
            "$ref": "#/components/schemas/ApiPrivateDownloadDeliveryUrl"
          readOnly: true
          type: array
        snapshotId:
          description: Unique 24-hexadecimal character string that identifies the
            snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        targetClusterName:
          description: Human-readable label that identifies the target cluster to
            which the restore job restores the snapshot. The resource returns this
            parameter when `"deliveryType":` `"automated"`. Required for `automated`
            and `pointInTime` restore types.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        targetGroupId:
          description: Unique 24-hexadecimal digit string that identifies the target
            project for the specified `targetClusterName`. Required for `automated`
            and `pointInTime` restore types.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        timestamp:
          description: Date and time when MongoDB Cloud took the snapshot associated
            with `snapshotId`. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
      required:
      - deliveryType
      type: object
    DiskBackupSnapshotSchedule20240805:
      properties:
        autoCopySettingsEnabled:
          description: Flag that indicates whether the copy settings are automatically
            managed by MongoDB Cloud and sync to the cluster topology.
          type: boolean
        autoExportEnabled:
          description: Flag that indicates whether MongoDB Cloud automatically exports
            Cloud Backup Snapshots to the Export Bucket.
          type: boolean
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the cluster
            with the Snapshot you want to return.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster with the Snapshot
            you want to return.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        copyPolicyItemsEnabled:
          description: Flag that indicates whether copy settings use `copyPolicyItems`
            instead of `frequencies`. When true, requests must supply `copyPolicyItems`
            and responses return `copyPolicyItems` only. When false or omitted, requests
            must supply `frequencies` and responses return `frequencies` only.
          type: boolean
        copySettings:
          description: List that contains a document for each copy setting item in
            the desired backup policy.
          items:
            "$ref": "#/components/schemas/DiskBackupCopySetting20240805"
          type: array
        deleteCopiedBackups:
          description: List that contains a document for each deleted copy setting
            whose backup copies you want to delete.
          items:
            "$ref": "#/components/schemas/DeleteCopiedBackups20240805"
          type: array
          writeOnly: true
        deleteCopySnapshots:
          description: Flag that indicates whether to delete Snapshot copies that
            MongoDB Cloud took previously when their associated `copyPolicyItems`
            are removed from a `copySetting`. This option requires `copyPolicyItemsEnabled`
            to be true.
          type: boolean
          writeOnly: true
        deleteSnapshots:
          description: Flag that indicates whether to delete Snapshots that MongoDB
            Cloud took previously when deleting the associated backup policy.
          type: boolean
          writeOnly: true
        export:
          "$ref": "#/components/schemas/AutoExportPolicyView"
        extraRetentionSettings:
          description: List that contains a document for each extra retention setting
            item in the desired backup policy.
          items:
            "$ref": "#/components/schemas/ExtraRetentionSetting"
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        nextSnapshot:
          description: Date and time when MongoDB Cloud takes the next Snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        policies:
          description: Rules set for this backup schedule.
          items:
            "$ref": "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy"
          maxItems: 1
          type: array
        referenceHourOfDay:
          description: Hour of day in Coordinated Universal Time (UTC) that represents
            when MongoDB Cloud takes the Snapshot.
          format: int32
          type: integer
        referenceMinuteOfHour:
          description: Minute of the `referenceHourOfDay` that represents when MongoDB
            Cloud takes the Snapshot.
          format: int32
          type: integer
        restoreWindowDays:
          description: Number of previous days that you can restore back to with Continuous
            Cloud Backup accuracy. You must specify a positive, non-zero integer.
            This parameter applies to continuous Cloud Backups only.
          format: int32
          type: integer
        updateCopySnapshots:
          description: Flag that indicates whether to apply the retention changes
            for updated copy policy items to Snapshot copies that MongoDB Cloud took
            previously.
          type: boolean
          writeOnly: true
        updateSnapshots:
          description: Flag that indicates whether to apply the retention changes
            in the updated backup policy to Snapshots that MongoDB Cloud took previously.
          type: boolean
          writeOnly: true
        useOrgAndGroupNamesInExportPrefix:
          description: Flag that indicates whether to use organization and project
            names instead of organization and project UUIDs in the path to the metadata
            files that MongoDB Cloud uploads to your Export Bucket.
          type: boolean
      required:
      - policies
      type: object
    DiskBackupTimeBasedCopyPolicyItem:
      allOf:
      - "$ref": "#/components/schemas/DiskBackupCopyPolicyItem"
      - properties:
          retentionUnit:
            description: Unit of time in which MongoDB Cloud measures snapshot copy
              retention.
            enum:
            - days
            - weeks
            - months
            - years
            type: string
          retentionValue:
            description: Duration in days, weeks, months, or years that MongoDB Cloud
              retains the snapshot copy.
            format: int32
            type: integer
        type: object
      description: Specifications for one time-based copy policy item.
      required:
      - frequencyType
      - retentionUnit
      - retentionValue
      type: object
    DiskGBAutoScaling:
      description: Setting that enables disk auto-scaling.
      properties:
        enabled:
          description: Flag that indicates whether this cluster enables disk auto-scaling.
            The maximum memory allowed for the selected cluster tier and the oplog
            size can limit storage auto-scaling.
          type: boolean
      type: object
    DiskPartitionQueueDepthDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionQueueDepthIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionQueueDepthJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionReadIopsDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionReadIopsIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionReadIopsJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionReadLatencyDataTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionReadLatencyIndexTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionReadLatencyJournalTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionSpaceUsedDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionSpaceUsedIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionSpaceUsedJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionWriteIopsDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionWriteIopsIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionWriteIopsJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionWriteLatencyDataTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionWriteLatencyIndexTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    DiskPartitionWriteLatencyJournalTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    Document:
      additionalProperties:
        type: object
      type: object
    DocumentDeletedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DocumentInsertedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DocumentReturnedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DocumentUpdatedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    DropIndexSuggestionsIndex:
      properties:
        accessCount:
          description: Usage count (since last restart) of index.
          format: int64
          type: integer
        index:
          description: List that contains documents that specify a key in the index
            and its sort order.
          items:
            description: One index key paired with its sort order. A value of `1`
              indicates an ascending sort order. A value of `-1` indicates a descending
              sort order. Keys in indexes with multiple keys appear in the same order
              that they appear in the index.
            type: object
          type: array
        name:
          description: Name of index.
          type: string
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          type: string
        shards:
          description: List that contains strings that specifies the shards where
            the index is found.
          items:
            description: Shard name.
            type: string
          type: array
        since:
          description: Date of most recent usage of index. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        sizeBytes:
          description: Size of index.
          format: int64
          type: integer
      type: object
    DropIndexSuggestionsResponse:
      properties:
        hiddenIndexes:
          description: List that contains the documents with information about the
            hidden indexes that the Performance Advisor suggests to remove.
          items:
            "$ref": "#/components/schemas/DropIndexSuggestionsIndex"
          readOnly: true
          type: array
        redundantIndexes:
          description: List that contains the documents with information about the
            redundant indexes that the Performance Advisor suggests to remove.
          items:
            "$ref": "#/components/schemas/DropIndexSuggestionsIndex"
          readOnly: true
          type: array
        unusedIndexes:
          description: List that contains the documents with information about the
            unused indexes that the Performance Advisor suggests to remove.
          items:
            "$ref": "#/components/schemas/DropIndexSuggestionsIndex"
          readOnly: true
          type: array
      type: object
    EARPrivateEndpoint:
      description: Encryption At Rest Private Endpoint.
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSKMSEARPrivateEndpoint"
          AZURE: "#/components/schemas/AzureKeyVaultEARPrivateEndpoint"
        propertyName: cloudProvider
      oneOf:
      - "$ref": "#/components/schemas/AzureKeyVaultEARPrivateEndpoint"
      - "$ref": "#/components/schemas/AWSKMSEARPrivateEndpoint"
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider for
            the Encryption At Rest private endpoint.
          enum:
          - AZURE
          - AWS
          readOnly: true
          type: string
        errorMessage:
          description: Error message for failures associated with the Encryption At
            Rest private endpoint.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        regionName:
          description: Cloud provider region in which the Encryption At Rest private
            endpoint is located.
          oneOf:
          - description: Microsoft Azure Regions.
            enum:
            - US_CENTRAL
            - US_EAST
            - US_EAST_2
            - US_NORTH_CENTRAL
            - US_WEST
            - US_SOUTH_CENTRAL
            - EUROPE_NORTH
            - EUROPE_WEST
            - US_WEST_CENTRAL
            - US_WEST_2
            - US_WEST_3
            - CANADA_EAST
            - CANADA_CENTRAL
            - BRAZIL_SOUTH
            - BRAZIL_SOUTHEAST
            - AUSTRALIA_CENTRAL
            - AUSTRALIA_CENTRAL_2
            - AUSTRALIA_EAST
            - AUSTRALIA_SOUTH_EAST
            - GERMANY_WEST_CENTRAL
            - GERMANY_NORTH
            - SWEDEN_CENTRAL
            - SWEDEN_SOUTH
            - SWITZERLAND_NORTH
            - SWITZERLAND_WEST
            - UK_SOUTH
            - UK_WEST
            - NORWAY_EAST
            - NORWAY_WEST
            - INDIA_CENTRAL
            - INDIA_SOUTH
            - INDIA_WEST
            - CHINA_EAST
            - CHINA_NORTH
            - ASIA_EAST
            - JAPAN_EAST
            - JAPAN_WEST
            - ASIA_SOUTH_EAST
            - KOREA_CENTRAL
            - KOREA_SOUTH
            - FRANCE_CENTRAL
            - FRANCE_SOUTH
            - SOUTH_AFRICA_NORTH
            - SOUTH_AFRICA_WEST
            - UAE_CENTRAL
            - UAE_NORTH
            - QATAR_CENTRAL
            - POLAND_CENTRAL
            - ISRAEL_CENTRAL
            - ITALY_NORTH
            - SPAIN_CENTRAL
            - MEXICO_CENTRAL
            - NEW_ZEALAND_NORTH
            - US_GOV_VIRGINIA
            - US_GOV_ARIZONA
            - US_GOV_TEXAS
            title: Azure Regions
            type: string
          - description: Physical location where MongoDB Cloud deploys your AWS-hosted
              MongoDB cluster nodes. The region you choose can affect network latency
              for clients accessing your databases. When MongoDB Cloud deploys a dedicated
              cluster, it checks if a VPC or VPC connection exists for that provider
              and region. If not, MongoDB Cloud creates them as part of the deployment.
              MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering
              connection to one CIDR block and region, create the connection first.
              Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - EU_CENTRAL_2
            - AP_EAST_1
            - AP_EAST_2
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTHEAST_4
            - AP_SOUTHEAST_5
            - AP_SOUTHEAST_6
            - AP_SOUTHEAST_7
            - AP_SOUTH_1
            - AP_SOUTH_2
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - ME_CENTRAL_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - EU_SOUTH_2
            - IL_CENTRAL_1
            - CA_WEST_1
            - MX_CENTRAL_1
            - GLOBAL
            title: AWS Regions
            type: string
          type: object
        status:
          description: State of the Encryption At Rest private endpoint.
          enum:
          - INITIATING
          - PENDING_ACCEPTANCE
          - ACTIVE
          - FAILED
          - PENDING_RECREATION
          - DELETING
          readOnly: true
          type: string
      title: Encryption At Rest Private Endpoint
      type: object
    EmailNotification:
      description: Email notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        emailAddress:
          description: |-
            Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `"notifications.[n].typeName" : "EMAIL"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:

            - specific MongoDB Cloud users (`"notifications.[n].typeName" : "USER"`)
            - MongoDB Cloud users with specific project roles (`"notifications.[n].typeName" : "GROUP"`)
            - MongoDB Cloud users with specific organization roles (`"notifications.[n].typeName" : "ORG"`)
            - MongoDB Cloud teams (`"notifications.[n].typeName" : "TEAM"`)

            To send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter.
          format: email
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - EMAIL
          type: string
      required:
      - typeName
      title: Email Notification
      type: object
    EmployeeAccessGrantView:
      description: MongoDB employee granted access level and expiration for a cluster.
      properties:
        expirationTime:
          description: Expiration date for the employee access grant. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        grantType:
          description: Level of access to grant to MongoDB Employees.
          enum:
          - CLUSTER_DATABASE_LOGS
          - CLUSTER_INFRASTRUCTURE
          - CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      required:
      - expirationTime
      - grantType
      type: object
    EncryptionAtRest:
      properties:
        awsKms:
          "$ref": "#/components/schemas/AWSKMSConfiguration"
        azureKeyVault:
          "$ref": "#/components/schemas/AzureKeyVault"
        enabledForSearchNodes:
          description: Flag that indicates whether Encryption at Rest for Dedicated
            Search Nodes is enabled in the specified project.
          type: boolean
        googleCloudKms:
          "$ref": "#/components/schemas/GoogleCloudKMS"
      type: object
    EncryptionKeyAlertConfigViewForNdsGroup:
      description: Encryption key alert configuration allows to select thresholds  which
        trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/EncryptionKeyEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/GreaterThanDaysThresholdView"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Encryption Key Alert Configuration
      type: object
    EncryptionKeyEventTypeViewAlertable:
      description: Event type that triggers an alert.
      enum:
      - AWS_ENCRYPTION_KEY_NEEDS_ROTATION
      - AZURE_ENCRYPTION_KEY_NEEDS_ROTATION
      - GCP_ENCRYPTION_KEY_NEEDS_ROTATION
      - AWS_ENCRYPTION_KEY_INVALID
      - AZURE_ENCRYPTION_KEY_INVALID
      - GCP_ENCRYPTION_KEY_INVALID
      example: AWS_ENCRYPTION_KEY_NEEDS_ROTATION
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Encryption Event Types
      type: string
    EndpointService:
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSPrivateLinkConnection"
          AZURE: "#/components/schemas/AzurePrivateLinkConnection"
          GCP: "#/components/schemas/GCPEndpointService"
        propertyName: cloudProvider
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        regionName:
          description: Cloud provider region that manages this Private Endpoint Service.
          readOnly: true
          type: string
        status:
          description: State of the Private Endpoint Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - WAITING_FOR_USER
          - FAILED
          - DELETING
          readOnly: true
          type: string
      required:
      - cloudProvider
      type: object
    EventSeverity:
      description: Severity of the event.
      enum:
      - INFO
      - WARNING
      - ERROR
      - CRITICAL
      type: string
    EventTypeDetails:
      description: A singular type of event.
      properties:
        alertable:
          description: Whether or not this event type can be configured as an alert
            via the API.
          readOnly: true
          type: boolean
        description:
          description: Description of the event type.
          readOnly: true
          type: string
        eventType:
          description: Enum representation of the event type.
          readOnly: true
          type: string
      title: Event type details
      type: object
    EventTypeForNdsGroup:
      oneOf:
      - enum:
        - ALERT_ACKNOWLEDGED_AUDIT
        - ALERT_UNACKNOWLEDGED_AUDIT
        title: Alert Audit Types
        type: string
      - enum:
        - ALERT_CONFIG_DISABLED_AUDIT
        - ALERT_CONFIG_ENABLED_AUDIT
        - ALERT_CONFIG_ADDED_AUDIT
        - ALERT_CONFIG_DELETED_AUDIT
        - ALERT_CONFIG_CHANGED_AUDIT
        title: Alert Audit Types
        type: string
      - 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
        title: API User Event Types
        type: string
      - enum:
        - SERVICE_ACCOUNT_CREATED
        - SERVICE_ACCOUNT_DELETED
        - SERVICE_ACCOUNT_ROLES_CHANGED
        - SERVICE_ACCOUNT_DETAILS_CHANGED
        - SERVICE_ACCOUNT_ADDED_TO_GROUP
        - SERVICE_ACCOUNT_REMOVED_FROM_GROUP
        - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED
        - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED
        - SERVICE_ACCOUNT_SECRET_ADDED
        - SERVICE_ACCOUNT_SECRET_DELETED
        - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED
        - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED
        title: Service Account Event Types
        type: string
      - 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
        title: App Services Event Types
        type: string
      - enum:
        - AUTO_INDEXING_ENABLED
        - AUTO_INDEXING_DISABLED
        - AUTO_INDEXING_INDEX_BUILD_SUBMITTED
        - AUTO_INDEXING_SLOW_INDEX_BUILD
        - AUTO_INDEXING_STALLED_INDEX_BUILD
        - AUTO_INDEXING_FAILED_INDEX_BUILD
        - AUTO_INDEXING_COMPLETED_INDEX_BUILD
        - AUTO_INDEXING_STARTED_INDEX_BUILD
        title: Auto Indexing Event Types
        type: string
      - enum:
        - AUTOMATION_CONFIG_PUBLISHED_AUDIT
        title: Automation Config Event Types
        type: string
      - enum:
        - PEER_CREATED
        - PEER_DELETED
        - PEER_UPDATED
        title: AWS Peer Vpc Audit Types
        type: string
      - enum:
        - AZURE_PEER_CREATED
        - AZURE_PEER_UPDATED
        - AZURE_PEER_ACTIVE
        - AZURE_PEER_DELETED
        title: Azure Peer Network Audit Types
        type: string
      - 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
        - DAILY_BILLING_CHANGE_NORMAL
        - DAILY_BILLING_CHANGE_OVER_THRESHOLD
        - WEEKLY_BILLING_CHANGE_NORMAL
        - WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
        - MONTHLY_BILLING_CHANGE_NORMAL
        - MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
        title: Billing Event Types
        type: string
      - enum:
        - CLUSTER_CONNECTION_GET_DATABASES
        - CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS
        - CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES
        - CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID
        - CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS
        - CLUSTER_CONNECTION_AGGREGATE
        - CLUSTER_CONNECTION_CREATE_COLLECTION
        - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES
        - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES
        - CLUSTER_CONNECTION_FIND_DOCUMENTS
        - CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA
        title: Cluster Connection Audit Types
        type: string
      - enum:
        - CLUSTER_MONGOS_IS_PRESENT
        - CLUSTER_MONGOS_IS_MISSING
        title: Cluster Event Types
        type: string
      - enum:
        - CPS_SNAPSHOT_STARTED
        - CPS_SNAPSHOT_SUCCESSFUL
        - CPS_SNAPSHOT_FAILED
        - CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY
        - CPS_SNAPSHOT_FALLBACK_SUCCESSFUL
        - CPS_SNAPSHOT_BEHIND
        - CPS_COPY_SNAPSHOT_STARTED
        - CPS_COPY_SNAPSHOT_FAILED
        - CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY
        - CPS_COPY_SNAPSHOT_SUCCESSFUL
        - CPS_PREV_SNAPSHOT_OLD
        - CPS_SNAPSHOT_FALLBACK_FAILED
        - CPS_RESTORE_SUCCESSFUL
        - CPS_EXPORT_SUCCESSFUL
        - CPS_RESTORE_FAILED
        - CPS_EXPORT_FAILED
        - CPS_COLLECTION_RESTORE_SUCCESSFUL
        - CPS_COLLECTION_RESTORE_FAILED
        - CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS
        - CPS_COLLECTION_RESTORE_CANCELED
        - CPS_AUTO_EXPORT_FAILED
        - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED
        - CPS_OPLOG_BEHIND
        - CPS_OPLOG_CAUGHT_UP
        title: Cps Backup Event Types
        type: string
      - enum:
        - DATA_EXPLORER
        - DATA_EXPLORER_CRUD_ATTEMPT
        - DATA_EXPLORER_CRUD_ERROR
        - DATA_EXPLORER_CRUD
        title: Data Explorer Accessed Event Types
        type: string
      - enum:
        - DATA_EXPLORER_SESSION_CREATED
        title: Data Explorer Event Types
        type: string
      - enum:
        - CPS_DATA_PROTECTION_ENABLE_REQUESTED
        - CPS_DATA_PROTECTION_ENABLED
        - CPS_DATA_PROTECTION_UPDATE_REQUESTED
        - CPS_DATA_PROTECTION_UPDATED
        - CPS_DATA_PROTECTION_DISABLE_REQUESTED
        - CPS_DATA_PROTECTION_DISABLED
        - CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT
        title: CPS Backup Compliance Policy Event Types
        type: string
      - enum:
        - CPS_RESTORE_REQUESTED_AUDIT
        - CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT
        - CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT
        - CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT
        - CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT
        - CPS_SNAPSHOT_DELETED_AUDIT
        - CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT
        - CPS_SNAPSHOT_IN_PROGRESS_AUDIT
        - CPS_SNAPSHOT_COMPLETED_AUDIT
        - CPS_ON_DEMAND_SNAPSHOT_REQUESTED
        - CPS_OPLOG_CAUGHT_UP_AUDIT
        - CPS_OPLOG_BEHIND_AUDIT
        title: Disk Backup Event Types
        type: string
      - enum:
        - AWS_ENCRYPTION_KEY_ROTATED
        - AWS_ENCRYPTION_KEY_NEEDS_ROTATION
        - AZURE_ENCRYPTION_KEY_ROTATED
        - AZURE_ENCRYPTION_KEY_NEEDS_ROTATION
        - GCP_ENCRYPTION_KEY_ROTATED
        - GCP_ENCRYPTION_KEY_NEEDS_ROTATION
        - AWS_ENCRYPTION_KEY_VALID
        - AWS_ENCRYPTION_KEY_INVALID
        - AZURE_ENCRYPTION_KEY_VALID
        - AZURE_ENCRYPTION_KEY_INVALID
        - GCP_ENCRYPTION_KEY_VALID
        - GCP_ENCRYPTION_KEY_INVALID
        title: Encryption Event Types
        type: string
      - enum:
        - BUCKET_CREATED_AUDIT
        - BUCKET_DELETED_AUDIT
        title: Export Bucket Audit Types
        type: string
      - enum:
        - FTS_INDEX_DELETION_FAILED
        - FTS_INDEX_BUILD_COMPLETE
        - FTS_INDEX_BUILD_FAILED
        - FTS_INDEX_CREATED
        - FTS_INDEX_UPDATED
        - FTS_INDEX_DELETED
        - FTS_INDEX_CLEANED_UP
        - FTS_INDEX_STALE
        - FTS_INDEXES_RESTORED
        - FTS_INDEXES_RESTORE_FAILED
        - FTS_INDEXES_SYNONYM_MAPPING_INVALID
        title: FTS Index Audit Types
        type: string
      - enum:
        - GCP_PEER_CREATED
        - GCP_PEER_DELETED
        - GCP_PEER_UPDATED
        - GCP_PEER_ACTIVE
        - GCP_PEER_INACTIVE
        title: GCP Peer Vpc Audit Types
        type: string
      - enum:
        - DATA_EXPLORER_ENABLED
        - DATA_EXPLORER_DISABLED
        - CREDIT_CARD_ADDED
        - CREDIT_CARD_UPDATED
        - GROUP_DELETED
        - GROUP_CREATED
        - GROUP_MOVED
        - GROUP_TEMPORARILY_ACTIVATED
        - GROUP_ACTIVATED
        - GROUP_LOCKED
        - GROUP_SUSPENDED
        - GROUP_FLUSHED
        - GROUP_NAME_CHANGED
        - GROUP_CHARTS_ACTIVATION_REQUESTED
        - GROUP_CHARTS_ACTIVATED
        - GROUP_CHARTS_UPGRADED
        - GROUP_CHARTS_RESET
        - GROUP_DEFAULT_ALERTS_SETTINGS_CHANGED
        title: Group Audit Types
        type: string
      - enum:
        - PAID_IN_FULL
        - DELINQUENT
        - ALL_USERS_HAVE_MULTI_FACTOR_AUTH
        - USERS_WITHOUT_MULTI_FACTOR_AUTH
        - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED
        - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED
        - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID
        - ENCRYPTION_AT_REST_CONFIG_IS_VALID
        - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING
        - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING
        - GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED
        - GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED
        - ACTIVE_LEGACY_TLS_CONNECTIONS
        - NO_ACTIVE_LEGACY_TLS_CONNECTIONS
        title: Group Event Types
        type: string
      - enum:
        - INTEGRATION_CONFIGURED
        - INTEGRATION_REMOVED
        title: Group Integration Event Types
        type: string
      - enum:
        - ATTEMPT_KILLOP_AUDIT
        - ATTEMPT_KILLSESSION_AUDIT
        - HOST_UP
        - HOST_DOWN
        - HOST_HAS_INDEX_SUGGESTIONS
        - HOST_MONGOT_RECOVERED_OOM
        - HOST_MONGOT_CRASHING_OOM
        - HOST_MONGOT_RESUME_REPLICATION
        - HOST_MONGOT_STOP_REPLICATION
        - HOST_MONGOT_UNPAUSE_INITIAL_SYNC
        - HOST_MONGOT_PAUSE_INITIAL_SYNC
        - HOST_MONGOT_SUFFICIENT_DISK_SPACE
        - HOST_MONGOT_APPROACHING_STOP_REPLICATION
        - HOST_MONGOT_RESTARTED
        - HOST_SEARCH_NODE_UNBLOCKED
        - HOST_SEARCH_NODE_INDEX_FAILED
        - HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN
        - HOST_EXTERNAL_LOG_SINK_EXPORT_RESUMED
        - HOST_ENOUGH_DISK_SPACE
        - HOST_NOT_ENOUGH_DISK_SPACE
        - SSH_KEY_NDS_HOST_ACCESS_REQUESTED
        - SSH_KEY_NDS_HOST_ACCESS_REFRESHED
        - SSH_KEY_NDS_HOST_ACCESS_ATTEMPT
        - SSH_KEY_NDS_HOST_ACCESS_GRANTED
        - SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED
        - ALERT_HOST_SSH_SESSION_STARTED
        - HOST_SSH_SESSION_ENDED
        - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS
        - PUSH_BASED_LOG_EXPORT_RESUMED
        - PUSH_BASED_LOG_EXPORT_STOPPED
        - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
        - HOST_VERSION_BEHIND
        - VERSION_BEHIND
        - HOST_EXPOSED
        - HOST_SSL_CERTIFICATE_STALE
        - HOST_SECURITY_CHECKUP_NOT_MET
        - PROFILER_CONFIGURED_TOO_WIDELY
        title: Host Event Types
        type: string
      - enum:
        - INSIDE_METRIC_THRESHOLD
        - OUTSIDE_METRIC_THRESHOLD
        title: Host Metric Event Types
        type: string
      - enum:
        - ROLLING_INDEX_FAILED_INDEX_BUILD
        - ROLLING_INDEX_SUCCESS_INDEX_BUILD
        - INDEX_FAILED_INDEX_BUILD
        - INDEX_SUCCESS_INDEX_BUILD
        title: Index Build Audit Types
        type: string
      - enum:
        - MONGOTUNE_INFO
        - MONGOTUNE_ALERT
        title: Mongotune Event Types
        type: string
      - enum:
        - CLUSTER_CREATED
        - CLUSTER_RESURRECTED
        - CLUSTER_READY
        - CLUSTER_UPDATE_SUBMITTED
        - CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED
        - CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED
        - CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED
        - CLUSTER_AUTOMATICALLY_PAUSED
        - CLUSTER_UPDATE_STARTED
        - CLUSTER_UPDATE_STARTED_INTERNAL
        - CLUSTER_UPDATE_COMPLETED
        - MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL
        - CLUSTER_DELETE_SUBMITTED
        - CLUSTER_DELETE_SUBMITTED_INTERNAL
        - CLUSTER_DELETED
        - CLUSTER_IMPORT_STARTED
        - CLUSTER_IMPORT_CANCELLED
        - CLUSTER_IMPORT_EXPIRED
        - CLUSTER_IMPORT_CUTOVER
        - CLUSTER_IMPORT_COMPLETED
        - CLUSTER_IMPORT_FAILED
        - CLUSTER_IMPORT_RESTART_REQUESTED
        - PROJECT_LIVE_IMPORT_OVERRIDES_ADDED
        - PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED
        - PROJECT_LIVE_IMPORT_OVERRIDES_DELETED
        - CLUSTER_OPLOG_RESIZED
        - CLUSTER_INSTANCE_RESTARTED
        - CLUSTER_INSTANCE_STOP_START
        - CLUSTER_INSTANCE_RESYNC_REQUESTED
        - CLUSTER_INSTANCE_RESYNC_CLEARED
        - CLUSTER_INSTANCE_UPDATE_REQUESTED
        - CLUSTER_INSTANCE_REPLACED
        - CLUSTER_INSTANCE_REPLACE_CLEARED
        - CLUSTER_INSTANCE_SWAPPED
        - CLUSTER_INSTANCE_SWAP_CLEARED
        - CLUSTER_INSTANCE_VM_RESTART_CLEARED
        - CLUSTER_INSTANCE_VM_REBOOT_CLEARED
        - CLUSTER_INSTANCE_CONFIG_UPDATED
        - CLUSTER_INSTANCE_AGENT_API_KEY_ROTATED
        - CLUSTER_INSTANCE_SSL_ROTATED
        - CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER
        - CLUSTER_INSTANCE_SSL_REVOKED
        - RELOAD_SSL_ON_PROCESSES
        - RELOAD_SSL_ON_PROCESSES_REQUESTED
        - CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED
        - DATA_LAKE_QUERY_LOGS_DOWNLOADED
        - FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED
        - ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED
        - MONGODB_LOGS_DOWNLOADED
        - MONGOSQLD_LOGS_DOWNLOADED
        - MONGOT_LOGS_DOWNLOADED
        - MONGODB_USER_ADDED
        - MONGODB_USER_DELETED
        - MONGODB_USER_X509_CERT_CREATED
        - MONGODB_USER_X509_CERT_REVOKED
        - MONGODB_USER_UPDATED
        - MONGODB_ROLE_ADDED
        - MONGODB_ROLE_DELETED
        - MONGODB_ROLE_UPDATED
        - NETWORK_PERMISSION_ENTRY_ADDED
        - NETWORK_PERMISSION_ENTRY_REMOVED
        - NETWORK_PERMISSION_ENTRY_UPDATED
        - PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED
        - PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED
        - PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED
        - PLAN_STARTED
        - PLAN_COMPLETED
        - PLAN_ABANDONED
        - PLAN_DECLINED
        - PLAN_FAILURE_COUNT_RESET
        - PLAN_ASAP_REQUESTED
        - INDEPENDENT_SHARD_AUTO_SCALING_AVAILABLE
        - INDEPENDENT_SHARD_SCALING_CLUSTER_MIGRATED
        - INDEPENDENT_SHARD_SCALING_CLUSTER_ROLLED_BACK
        - MOVE_SKIPPED
        - STEP_SKIPPED
        - PROXY_RESTARTED
        - PROXY_PANICKED
        - ATLAS_MAINTENANCE_PROTECTED_HOURS_CREATED
        - ATLAS_MAINTENANCE_PROTECTED_HOURS_MODIFIED
        - ATLAS_MAINTENANCE_PROTECTED_HOURS_REMOVED
        - ATLAS_MAINTENANCE_WINDOW_ADDED
        - ATLAS_MAINTENANCE_WINDOW_MODIFIED
        - ATLAS_MAINTENANCE_WINDOW_REMOVED
        - ATLAS_MAINTENANCE_START_ASAP
        - ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW
        - ATLAS_MAINTENANCE_DEFERRED
        - ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED
        - ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED
        - ATLAS_MAINTENANCE_RESET_BY_ADMIN
        - ATLAS_MAINTENANCE_DEFERRED_BY_ADMIN
        - SCHEDULED_MAINTENANCE
        - PROJECT_SCHEDULED_MAINTENANCE
        - PROJECT_LIMIT_UPDATED
        - PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED
        - OS_MAINTENANCE
        - OS_MAINTENANCE_RESTART
        - OS_MAINTENANCE_REPLACEMENT
        - FREE_UPGRADE_STARTED
        - FLEX_UPGRADE_STARTED
        - SERVERLESS_UPGRADE_STARTED
        - TEST_FAILOVER_REQUESTED
        - USER_SECURITY_SETTINGS_UPDATED
        - AUDIT_LOG_CONFIGURATION_UPDATED
        - STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED
        - ENCRYPTION_AT_REST_CONFIGURATION_UPDATED
        - ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED
        - ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_SUCCEEDED
        - ENCRYPTION_AT_REST_KEY_ROTATION_STARTED
        - ENCRYPTION_AT_REST_PRIVATE_ENDPOINT_CREATED
        - ENCRYPTION_AT_REST_PRIVATE_ENDPOINT_DELETED
        - NDS_SET_IMAGE_OVERRIDES
        - NDS_SET_CHEF_TARBALL_URI
        - RESTRICTED_EMPLOYEE_ACCESS_BYPASS
        - REVOKED_EMPLOYEE_ACCESS_BYPASS
        - DEVICE_SYNC_DEBUG_ACCESS_GRANTED
        - DEVICE_SYNC_DEBUG_ACCESS_REVOKED
        - DEVICE_SYNC_DEBUG_X509_CERT_CREATED
        - EMPLOYEE_ACCESS_GRANTED
        - EMPLOYEE_ACCESS_REVOKED
        - QUERY_ENGINE_TENANT_CREATED
        - QUERY_ENGINE_TENANT_UPDATED
        - QUERY_ENGINE_TENANT_REMOVED
        - FEDERATED_DATABASE_CREATED
        - FEDERATED_DATABASE_UPDATED
        - FEDERATED_DATABASE_REMOVED
        - TENANT_SNAPSHOT_FAILED
        - TENANT_RESTORE_FAILED
        - SAMPLE_DATASET_LOAD_REQUESTED
        - CUSTOMER_X509_CRL_UPDATED
        - CONTAINER_SUBNETS_UPDATE_REQUESTED
        - ONLINE_ARCHIVE_CREATED
        - ONLINE_ARCHIVE_DELETED
        - ONLINE_ARCHIVE_UPDATED
        - ONLINE_ARCHIVE_PAUSE_REQUESTED
        - ONLINE_ARCHIVE_PAUSED
        - ONLINE_ARCHIVE_ACTIVE
        - ONLINE_ARCHIVE_ORPHANED
        - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED
        - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED
        - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED
        - ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED
        - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED
        - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED
        - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED
        - CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED
        - CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED
        - CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED
        - CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_ADDED
        - CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_DELETED
        - CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_UPDATED
        - PENDING_INDEXES_DELETED
        - PENDING_INDEXES_CANCELED
        - PROCESS_RESTART_REQUESTED
        - AUTO_HEALING_ACTION
        - AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE
        - AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT
        - AUTO_HEALING_REQUESTED_NODE_RESYNC
        - EXTRA_MAINTENANCE_DEFERRAL_GRANTED
        - GROUP_AUTOMATION_CONFIG_PUBLISHED
        - CLUSTER_AUTOMATION_CONFIG_PUBLISHED
        - SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER
        - CLUSTER_LINKED_TO_VERCEL
        - CLUSTER_UNLINKED_FROM_VERCEL
        - INGESTION_PIPELINE_DELETED
        - INGESTION_PIPELINE_DESTROYED
        - INGESTION_PIPELINE_CREATED
        - INGESTION_PIPELINE_UPDATED
        - OS_TUNE_FILE_OVERRIDES
        - MONITORING_AGENT_OVERRIDES
        - MONITORING_AGENT_REBALANCE_FLAG
        - MONITORING_AGENT_REBALANCE_TRIGGERED
        - CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED
        - CLUSTER_FORCE_PLANNED
        - CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED
        - CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START
        - CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED
        - CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED
        - CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE
        - UIS_PANICKED
        - TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL
        - TENANT_UPGRADE_TO_SERVERLESS_FAILED
        - SERVERLESS_UPGRADE_TO_DEDICATED_SUCCESSFUL
        - SERVERLESS_UPGRADE_TO_DEDICATED_FAILED
        - CLUSTER_FORCE_RECONFIG_REQUESTED
        - PROJECT_BYPASSED_MAINTENANCE
        - FEATURE_FLAG_MAINTENANCE
        - DATA_FEDERATION_QUERY_LIMIT_CONFIGURED
        - DATA_FEDERATION_QUERY_LIMIT_DELETED
        - DATA_API_SETUP_FOR_VERCEL
        - ADMIN_CLUSTER_LOCK_UPDATED
        - CLUSTER_ROLLING_RESYNC_STARTED
        - CLUSTER_ROLLING_RESYNC_COMPLETED
        - CLUSTER_ROLLING_RESYNC_FAILED
        - NODE_ROLLING_RESYNC_SCHEDULED
        - CLUSTER_ROLLING_RESYNC_CANCELED
        - CLUSTER_OS_UPDATED
        - CLUSTER_INSTANCE_FAMILY_UPDATED
        - PUSH_BASED_LOG_EXPORT_ENABLED
        - PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED
        - PUSH_BASED_LOG_EXPORT_DISABLED
        - LOG_STREAMING_ENABLED
        - LOG_STREAMING_CONFIGURATION_UPDATED
        - LOG_STREAMING_DISABLED
        - DATADOG_LOG_STREAMING_ENABLED
        - DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED
        - DATADOG_LOG_STREAMING_DISABLED
        - SPLUNK_LOG_STREAMING_ENABLED
        - SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED
        - SPLUNK_LOG_STREAMING_DISABLED
        - S3_LOG_STREAMING_ENABLED
        - S3_LOG_STREAMING_CONFIGURATION_UPDATED
        - S3_LOG_STREAMING_DISABLED
        - AZURE_LOG_STREAMING_ENABLED
        - AZURE_LOG_STREAMING_CONFIGURATION_UPDATED
        - AZURE_LOG_STREAMING_DISABLED
        - GCP_LOG_STREAMING_ENABLED
        - GCP_LOG_STREAMING_CONFIGURATION_UPDATED
        - GCP_LOG_STREAMING_DISABLED
        - OTEL_LOG_STREAMING_ENABLED
        - OTEL_LOG_STREAMING_CONFIGURATION_UPDATED
        - OTEL_LOG_STREAMING_DISABLED
        - OTEL_METRIC_INTEGRATION_ENABLED
        - OTEL_METRIC_INTEGRATION_CONFIGURATION_UPDATED
        - OTEL_METRIC_INTEGRATION_DISABLED
        - AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED
        - CONTAINER_DELETED
        - REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED
        - REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED
        - STREAM_TENANT_CREATED
        - STREAM_TENANT_UPDATED
        - STREAM_TENANT_DELETED
        - STREAM_TENANT_CONNECTIONS_LISTED
        - STREAM_TENANT_CONNECTION_UPDATED
        - STREAM_TENANT_CONNECTION_DELETED
        - STREAM_TENANT_CONNECTION_CREATED
        - STREAM_TENANT_CONNECTION_VIEWED
        - STREAM_TENANT_OPERATIONAL_LOGS
        - STREAM_TENANT_AUDIT_LOGS
        - STREAM_TENANT_AUDIT_LOGS_DELETED
        - QUEUED_ADMIN_ACTION_CREATED
        - QUEUED_ADMIN_ACTION_COMPLETED
        - QUEUED_ADMIN_ACTION_CANCELLED
        - ATLAS_SQL_SCHEDULED_UPDATE_CREATED
        - ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED
        - ATLAS_SQL_SCHEDULED_UPDATE_REMOVED
        - CLUSTER_INSTANCE_DISABLED
        - CLUSTER_INSTANCE_ENABLED
        - CLUSTER_BLOCK_WRITE
        - CLUSTER_UNBLOCK_WRITE
        - KMIP_KEY_ROTATION_SCHEDULED
        - SSL_CERTIFICATE_ISSUED
        - PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS
        - CLUSTER_CANCELING_SHARD_DRAIN_REQUESTED
        - CLUSTER_CANCELING_CONFIG_SERVER_TRANSITION_REQUESTED
        - CLUSTER_MIGRATE_BACK_TO_AWS_MANAGED_IP_REQUESTED
        - CLUSTER_IP_MIGRATED_FIRST_ROUND
        - CLUSTER_IP_MIGRATED_SECOND_ROUND
        - CLUSTER_IP_MIGRATED_FINAL_ROUND
        - CLUSTER_IP_ROLLED_BACK
        - AZ_BALANCING_OVERRIDE_MODIFIED
        - FTDC_SETTINGS_UPDATED
        - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED
        - MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE
        - MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE
        - PREDICTIVE_AUTOSCALING_ENABLED
        - PREDICTIVE_AUTOSCALING_DISABLED
        - SHADOW_CLUSTER_CREATE_EXPOSURE
        - SHADOW_CLUSTER_DELETE_EXPOSURE
        - SHADOW_CLUSTER_RECORDING_STATUS_UPDATE
        - SHADOW_CLUSTER_REPLAY_STATUS_UPDATE
        - NODE_HIDDEN_BY_ADMIN
        - NODE_UNHIDDEN_BY_ADMIN
        - CLUSTER_CREATED_VIA_ANIS
        title: Atlas Audit Types
        type: string
      - enum:
        - DB_CHECK_UPDATED
        - CLUSTER_SAMPLED_FOR_DB_CHECK
        - DB_CHECK_SCHEDULED_FOR_CLUSTER
        - DB_CHECK_DEFERRED_FOR_CLUSTER
        - CLUSTER_OPTED_OUT_OF_DB_CHECK
        title: DB Check Audit Types
        type: string
      - enum:
        - CLUSTER_SAMPLED_FOR_DATA_VALIDATION
        - DATA_VALIDATION_SUBMITTED_FOR_CLUSTER
        - CLUSTER_OPTED_OUT_OF_DATA_VALIDATION
        - REPLICA_SET_SAMPLED_FOR_INTER_NODE_DATA_VALIDATION
        - REPLICA_SET_OPTED_OUT_OF_INTER_NODE_DATA_VALIDATION
        - INTER_NODE_DATA_VALIDATION_SUBMITTED_FOR_REPLICA_SET
        title: Data Validation Audit Types
        type: string
      - enum:
        - COMPUTE_AUTO_SCALE_INITIATED
        - DISK_AUTO_SCALE_INITIATED
        - COMPUTE_AUTO_SCALE_INITIATED_BASE
        - COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS
        - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE
        - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS
        - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_BASE
        - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_ANALYTICS
        - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
        - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS
        - COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
        - COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS
        - DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL
        - DISK_AUTO_SCALE_OPLOG_FAIL
        - PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE
        - PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
        - PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
        - CLUSTER_AUTO_SHARDING_INITIATED
        title: Auto Scaling Audit Types
        type: string
      - enum:
        - MAINTENANCE_IN_ADVANCED
        - MAINTENANCE_AUTO_DEFERRED
        - MAINTENANCE_STARTED
        - MAINTENANCE_COMPLETED
        - MAINTENANCE_NO_LONGER_NEEDED
        title: Maintenance Window Audit Types
        type: string
      - enum:
        - SERVERLESS_AUTO_SCALING_INITIATED
        - SERVERLESS_VERTICAL_SCALING_INITIATED
        - SERVERLESS_HORIZONTAL_SCALING_INITIATED
        - SERVERLESS_MTM_DRAIN_REQUESTED
        - SERVERLESS_MTM_DRAIN_INITIATED
        - SERVERLESS_MTM_DRAIN_COMPLETED
        - SERVERLESS_MTM_DRAIN_STOPPED
        title: Serverless Auto Scaling Audit Types
        type: string
      - enum:
        - SERVERLESS_INSTANCE_CREATED
        - SERVERLESS_INSTANCE_READY
        - SERVERLESS_INSTANCE_UPDATE_SUBMITTED
        - SERVERLESS_INSTANCE_UPDATE_STARTED
        - SERVERLESS_INSTANCE_UPDATE_COMPLETED
        - SERVERLESS_INSTANCE_DELETE_SUBMITTED
        - SERVERLESS_INSTANCE_DELETED
        - SERVERLESS_INSTANCE_UNBLOCKED
        title: Serverless Instance Audit Types
        type: string
      - enum:
        - TENANT_ENDPOINT_CREATED
        - TENANT_ENDPOINT_RESERVED
        - TENANT_ENDPOINT_RESERVATION_FAILED
        - TENANT_ENDPOINT_UPDATED
        - TENANT_ENDPOINT_INITIATING
        - TENANT_ENDPOINT_AVAILABLE
        - TENANT_ENDPOINT_FAILED
        - TENANT_ENDPOINT_DELETING
        - TENANT_ENDPOINT_DELETED
        - TENANT_ENDPOINT_EXPIRED
        title: Auto Scaling Audit Types
        type: string
      - enum:
        - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED
        - TENANT_ENDPOINT_SERVICE_CREATED
        - TENANT_ENDPOINT_SERVICE_AVAILABLE
        - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED
        - TENANT_ENDPOINT_SERVICE_DELETED
        - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED
        - TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED
        title: Tenant Endpoint Service Deployment Audit Types
        type: string
      - enum:
        - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED
        - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK
        - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED
        - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK
        - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED
        - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK
        title: x509 User Auth Event Types
        type: string
      - enum:
        - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK
        - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED
        - ONLINE_ARCHIVE_UP_TO_DATE
        - ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED
        - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK
        title: Online Archive Event Types
        type: string
      - enum:
        - CROSS_REGION_SUPPORTED_REGION_MODIFIED
        - ENDPOINT_SERVICE_CREATED
        - ENDPOINT_SERVICE_DELETED
        - INTERFACE_ENDPOINT_CREATED
        - INTERFACE_ENDPOINT_DELETED
        - INTERFACE_ENDPOINT_PATCHED
        - INTERFACE_ENDPOINT_RETRIED
        title: Private Link Audit Types
        type: string
      - enum:
        - PROACTIVE_OPERATION_EVENT_LOGGED
        title: Proactive Operation Event Types
        type: string
      - enum:
        - PRIMARY_ELECTED
        - REPLICATION_OPLOG_WINDOW_HEALTHY
        - REPLICATION_OPLOG_WINDOW_RUNNING_OUT
        - ONE_PRIMARY
        - NO_PRIMARY
        - TOO_MANY_ELECTIONS
        - TOO_FEW_HEALTHY_MEMBERS
        - TOO_MANY_UNHEALTHY_MEMBERS
        title: ReplicaSet Event Types
        type: string
      - enum:
        - SEARCH_DEPLOYMENT_CREATED
        - SEARCH_DEPLOYMENT_UPDATED
        - SEARCH_DEPLOYMENT_DELETED
        title: Search Deployment Audit Types
        type: string
      - enum:
        - SERVERLESS_DEPLOYMENT_CREATED
        - SERVERLESS_DEPLOYMENT_DELETED
        - SERVERLESS_DEPLOYMENT_UPDATED
        - SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED
        - SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED
        - SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED
        - SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED
        - SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED
        title: Serverless Deployment Audit Types
        type: string
      - enum:
        - INSIDE_SERVERLESS_METRIC_THRESHOLD
        - OUTSIDE_SERVERLESS_METRIC_THRESHOLD
        title: Serverless Event Types
        type: string
      - enum:
        - INSIDE_FLEX_METRIC_THRESHOLD
        - OUTSIDE_FLEX_METRIC_THRESHOLD
        title: Flex Metric Event Types
        type: string
      - enum:
        - SETUP_SERVERLESS_INITIATED
        title: Setup Serverless Audit Types
        type: string
      - enum:
        - MAX_PROCESSOR_COUNT_REACHED
        title: Streams Event Types
        type: string
      - enum:
        - STREAM_PROCESSOR_STATE_IS_FAILED
        - INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
        - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
        title: Stream Processor Event Types
        type: string
      - enum:
        - CASE_CREATED
        title: Support Case Event Types
        type: string
      - enum:
        - SUPPORT_EMAILS_SENT_SUCCESSFULLY
        - SUPPORT_EMAILS_SENT_FAILURE
        title: Support Event Types
        type: string
      - enum:
        - TEAM_ADDED_TO_GROUP
        - TEAM_REMOVED_FROM_GROUP
        - TEAM_ROLES_MODIFIED
        title: Team Event Types
        type: string
      - enum:
        - TENANT_SNAPSHOT_STARTED_AUDIT
        - TENANT_SNAPSHOT_COMPLETED_AUDIT
        - TENANT_SNAPSHOT_DELETED_AUDIT
        - TENANT_RESTORE_REQUESTED_AUDIT
        - TENANT_RESTORE_COMPLETED_AUDIT
        - TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT
        title: Tenant Backup Event Types
        type: string
      - enum:
        - JOINED_GROUP
        - REMOVED_FROM_GROUP
        - INVITED_TO_GROUP
        - REQUESTED_TO_JOIN_GROUP
        - GROUP_INVITATION_DELETED
        - USER_ROLES_CHANGED_AUDIT
        - JOIN_GROUP_REQUEST_DENIED_AUDIT
        - JOIN_GROUP_REQUEST_APPROVED_AUDIT
        title: User Event Types
        type: string
      - enum:
        - CLUSTER_FCV_FIXED
        - CLUSTER_FCV_UNFIXED
        - CLUSTER_FCV_EXPIRATION_DATE_UPDATED
        - CLUSTER_FCV_DOWNGRADED
        - CLUSTER_BINARY_VERSION_DOWNGRADED
        - CLUSTER_BINARY_VERSION_UPGRADED
        - CLUSTER_OS_FIXED
        - CLUSTER_OS_UNFIXED
        title: Version Audit Types
        type: string
      - enum:
        - TAGS_MODIFIED
        - CLUSTER_TAGS_MODIFIED
        - GROUP_TAGS_MODIFIED
        title: Resource Event Types
        type: string
      - enum:
        - EMPLOYEE_DOWNLOADED_CLUSTER_LOGS
        title: Access Event Types
        type: string
      - enum:
        - CHARTS_API_SUCCESS
        - CHARTS_API_FAILURE
        title: Charts Api Call Audit Types
        type: string
      - enum:
        - RESOURCE_POLICY_VIOLATED
        title: Atlas Resource Policy Audit Types
        type: string
      - enum:
        - QUERY_SHAPE_BLOCKED
        - QUERY_SHAPE_UNBLOCKED
        title: Query Shape Event Types
        type: string
      - enum:
        - SHARD_KEY_ANALYSIS_STARTED
        - SHARD_KEY_ANALYSIS_FINISHED
        - QUERY_SAMPLING_STARTED
        - QUERY_SAMPLING_STOPPED
        title: Shard Key Advisor Event Types
        type: string
      - enum:
        - AI_MODELS_API_KEY_CREATED
        - AI_MODELS_API_KEY_DELETED
        title: Ai Models Event Types
        type: string
      type: object
    EventTypeForOrg:
      oneOf:
      - enum:
        - ALERT_ACKNOWLEDGED_AUDIT
        - ALERT_UNACKNOWLEDGED_AUDIT
        title: Alert Audit Types
        type: string
      - enum:
        - ALERT_CONFIG_DISABLED_AUDIT
        - ALERT_CONFIG_ENABLED_AUDIT
        - ALERT_CONFIG_ADDED_AUDIT
        - ALERT_CONFIG_DELETED_AUDIT
        - ALERT_CONFIG_CHANGED_AUDIT
        title: Alert Audit Types
        type: string
      - 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
        title: API User Event Types
        type: string
      - enum:
        - SERVICE_ACCOUNT_CREATED
        - SERVICE_ACCOUNT_DELETED
        - SERVICE_ACCOUNT_ROLES_CHANGED
        - SERVICE_ACCOUNT_DETAILS_CHANGED
        - SERVICE_ACCOUNT_ADDED_TO_GROUP
        - SERVICE_ACCOUNT_REMOVED_FROM_GROUP
        - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED
        - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED
        - SERVICE_ACCOUNT_SECRET_ADDED
        - SERVICE_ACCOUNT_SECRET_DELETED
        - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED
        - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED
        title: Service Account Event Types
        type: string
      - enum:
        - AWS_PAYMENT_PAID
        - 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_SFOLID_MODIFIED
        - PREPAID_PLAN_MODIFIED
        - AWS_USAGE_REPORTED
        - AZURE_USAGE_REPORTED
        - GCP_USAGE_REPORTED
        - VERCEL_USAGE_REPORTED
        - BECAME_PAYING_ORG
        - BECAME_LINKED_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
        - EVERGREEN_PRIORITY_MODIFIED
        - CROSS_ORG_OPERATION_TICKET_TRACKING
        - ADMIN_OVERRIDE_PAYMENT_METHOD_DELETED
        - ADMIN_OVERRIDE_PAYMENT_METHOD_EXPIRED
        - PAYMENT_METHOD_FLAGGED
        - PAYMENT_METHOD_UNFLAGGED
        - MARKETPLACE_REFUND_ISSUED
        - PAYMENT_DUE_DATE_EXTENDED
        title: Billing Event Types
        type: string
      - enum:
        - FEDERATION_SETTINGS_CREATED
        - FEDERATION_SETTINGS_DELETED
        - FEDERATION_SETTINGS_UPDATED
        - IDENTITY_PROVIDER_CREATED
        - IDENTITY_PROVIDER_UPDATED
        - IDENTITY_PROVIDER_DELETED
        - IDENTITY_PROVIDER_ACTIVATED
        - OIDC_IDENTITY_PROVIDER_UPDATED
        - IDENTITY_PROVIDER_DEACTIVATED
        - IDENTITY_PROVIDER_JWKS_REVOKED
        - OIDC_IDENTITY_PROVIDER_ENABLED
        - OIDC_IDENTITY_PROVIDER_DISABLED
        - DOMAINS_ASSOCIATED
        - DOMAIN_CREATED
        - DOMAIN_DELETED
        - DOMAIN_VERIFIED
        - ORG_SETTINGS_CONFIGURED
        - ORG_SETTINGS_UPDATED
        - ORG_SETTINGS_DELETED
        - RESTRICT_ORG_MEMBERSHIP_ENABLED
        - RESTRICT_ORG_MEMBERSHIP_DISABLED
        - ROLE_MAPPING_CREATED
        - ROLE_MAPPING_UPDATED
        - ROLE_MAPPING_DELETED
        title: Federation Settings Event Types
        type: string
      - enum:
        - GROUP_DELETED
        - GROUP_CREATED
        - GROUP_MOVED
        title: Group Audit Types
        type: string
      - enum:
        - MLAB_MIGRATION_COMPLETED
        - MLAB_MIGRATION_TARGET_CLUSTER_CREATED
        - MLAB_MIGRATION_DATABASE_USERS_IMPORTED
        - MLAB_MIGRATION_IP_WHITELIST_IMPORTED
        - MLAB_MIGRATION_TARGET_CLUSTER_SET
        - MLAB_MIGRATION_DATABASE_RENAMED
        - MLAB_MIGRATION_LIVE_IMPORT_STARTED
        - MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER
        - MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE
        - MLAB_MIGRATION_LIVE_IMPORT_ERROR
        - MLAB_MIGRATION_LIVE_IMPORT_CANCELLED
        - MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED
        - MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED
        - MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED
        - MLAB_MIGRATION_SUPPORT_PLAN_SELECTED
        - MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT
        title: Mlab Migration Audit Types
        type: string
      - enum:
        - ORG_LIMIT_UPDATED
        - SHADOW_CLUSTER_ORG_OPT_IN
        - SHADOW_CLUSTER_ORG_OPT_OUT
        title: Atlas Audit Types
        type: string
      - enum:
        - ORG_CREATED
        - CUSTOM_SESSION_TIMEOUT_MODIFIED
        - SECURITY_CONTACT_MODIFIED
        - ORG_CREDIT_CARD_ADDED
        - ORG_CREDIT_CARD_UPDATED
        - ORG_CREDIT_CARD_CURRENT
        - ORG_CREDIT_CARD_ABOUT_TO_EXPIRE
        - ORG_PAYPAL_LINKED
        - ORG_PAYPAL_UPDATED
        - ORG_PAYPAL_CANCELLED
        - ORG_OVERRIDE_PAYMENT_METHOD_ADDED
        - ORG_BANK_ACCOUNT_ADDED
        - ORG_BANK_ACCOUNT_UPDATED
        - ORG_WALLET_ADDED
        - ORG_WALLET_UPDATED
        - ORG_ACTIVATED
        - ORG_TEMPORARILY_ACTIVATED
        - ORG_SUSPENSION_DATE_CHANGED
        - ORG_SUSPENDED
        - ORG_ADMIN_SUSPENDED
        - ORG_ADMIN_LOCKED
        - ORG_CLUSTERS_DELETED
        - ORG_CLUSTERS_PAUSED
        - ORG_LOCKED
        - ORG_LOCKED_ACCELERATED
        - ORG_UNDER_FINANCIAL_PROTECTION
        - ORG_NO_FINANCIAL_PROTECTION
        - ORG_RENAMED
        - ALL_ORG_USERS_HAVE_MFA
        - ORG_USERS_WITHOUT_MFA
        - ORG_INVOICE_UNDER_THRESHOLD
        - ORG_INVOICE_OVER_THRESHOLD
        - ORG_DAILY_BILL_UNDER_THRESHOLD
        - ORG_DAILY_BILL_OVER_THRESHOLD
        - ORG_DAILY_BILLING_CHANGE_NORMAL
        - ORG_DAILY_BILLING_CHANGE_OVER_THRESHOLD
        - ORG_WEEKLY_BILLING_CHANGE_NORMAL
        - ORG_WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
        - ORG_MONTHLY_BILLING_CHANGE_NORMAL
        - ORG_MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
        - ORG_GROUP_CHARGES_UNDER_THRESHOLD
        - ORG_GROUP_CHARGES_OVER_THRESHOLD
        - ORG_TWO_FACTOR_AUTH_REQUIRED
        - ORG_TWO_FACTOR_AUTH_OPTIONAL
        - ORG_PUBLIC_API_ACCESS_LIST_REQUIRED
        - ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED
        - ORG_EMPLOYEE_ACCESS_RESTRICTED
        - ORG_EMPLOYEE_ACCESS_UNRESTRICTED
        - ORG_CONNECTED_TO_MLAB
        - ORG_DISCONNECTED_FROM_MLAB
        - ORG_IDP_CERTIFICATE_CURRENT
        - ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE
        - ORG_CONNECTED_TO_VERCEL
        - ORG_DISCONNECTED_TO_VERCEL
        - ORG_CONNECTION_UNINSTALLED_FROM_VERCEL
        - ORG_UI_IP_ACCESS_LIST_ENABLED
        - ORG_UI_IP_ACCESS_LIST_DISABLED
        - ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES
        - ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED
        - ORG_SERVICE_ACCOUNT_SECRETS_EXPIRED
        - ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED
        - ORG_SERVICE_ACCOUNT_SECRETS_EXPIRING
        - ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING
        - ORG_MONGODB_VERSION_EOL_EXTENSION_ACCEPTED
        - ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING
        - ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED
        - ORG_BAAS_EOL_EXTENSION_ACCEPTED
        - ORG_BAAS_EOL_EXTENSION_PENDING
        - ORG_BAAS_EOL_EXTENSION_CANCELED
        - GROUP_MOVED_FROM_ORG
        - SANDBOX_ENABLED_FOR_ORG
        - SANDBOX_DISABLED_FOR_ORG
        - SANDBOX_CONFIG_DELETED
        - SANDBOX_TEMPLATE_UPDATED
        - ORGANIZATION_VOYAGE_SETTINGS_CREATED
        - ORGANIZATION_VOYAGE_SETTINGS_DELETED
        - PROJECT_CREATED_VIA_ANIS
        title: Org Event Types
        type: string
      - enum:
        - AWS_SELF_SERVE_ACCOUNT_LINKED
        - AWS_SELF_SERVE_ACCOUNT_LINK_PENDING
        - AWS_SELF_SERVE_ACCOUNT_CANCELLED
        - AWS_SELF_SERVE_ACCOUNT_LINK_FAILED
        - GCP_SELF_SERVE_ACCOUNT_LINK_PENDING
        - GCP_SELF_SERVE_ACCOUNT_LINK_FAILED
        - AZURE_SELF_SERVE_ACCOUNT_LINKED
        - AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING
        - AZURE_SELF_SERVE_ACCOUNT_CANCELLED
        - AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED
        - GCP_SELF_SERVE_ACCOUNT_LINKED
        - GCP_SELF_SERVE_ACCOUNT_CANCELLED
        - VERCEL_SELF_SERVE_ACCOUNT_LINKED
        - VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING
        - VERCEL_SELF_SERVE_ACCOUNT_CANCELLED
        - VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED
        - VERCEL_INVOICE_CREATED
        - VERCEL_INVOICE_NOT_PAID
        - VERCEL_INVOICE_OVERDUE
        - VERCEL_INVOICE_PAID
        - VERCEL_INVOICE_REFUNDED
        title: Partner Event Types
        type: string
      - enum:
        - SUPPORT_EMAILS_SENT_SUCCESSFULLY
        - SUPPORT_EMAILS_SENT_FAILURE
        title: Support Event Types
        type: string
      - enum:
        - TEAM_CREATED
        - TEAM_DELETED
        - TEAM_UPDATED
        - TEAM_NAME_CHANGED
        - TEAM_ADDED_TO_GROUP
        - TEAM_REMOVED_FROM_GROUP
        - TEAM_ROLES_MODIFIED
        title: Team Event Types
        type: string
      - enum:
        - JOINED_ORG
        - JOINED_TEAM
        - INVITED_TO_ORG
        - ORG_INVITATION_DELETED
        - REMOVED_FROM_ORG
        - REMOVED_FROM_TEAM
        - USER_ROLES_CHANGED_AUDIT
        - ORG_FLEX_CONSULTING_PURCHASED
        - ORG_FLEX_CONSULTING_PURCHASE_FAILED
        - INVITED_TO_TEAM
        title: User Event Types
        type: string
      - enum:
        - TAGS_MODIFIED
        - GROUP_TAGS_MODIFIED
        title: Resource Event Types
        type: string
      - enum:
        - RESOURCE_POLICY_CREATED
        - RESOURCE_POLICY_MODIFIED
        - RESOURCE_POLICY_DELETED
        - RESOURCE_POLICY_VIOLATED
        title: Atlas Resource Policy Audit Types
        type: string
      - enum:
        - AI_MODELS_USAGE_TIER_UPDATED
        title: Ai Models Event Types
        type: string
      type: object
    EventViewForNdsGroup:
      oneOf:
      - "$ref": "#/components/schemas/DefaultEventViewForNdsGroup"
      - "$ref": "#/components/schemas/AlertAudit"
      - "$ref": "#/components/schemas/AlertConfigAudit"
      - "$ref": "#/components/schemas/ApiUserEventViewForNdsGroup"
      - "$ref": "#/components/schemas/ServiceAccountGroupEvents"
      - "$ref": "#/components/schemas/AutomationConfigEventView"
      - "$ref": "#/components/schemas/AppServiceEventView"
      - "$ref": "#/components/schemas/BillingEventViewForNdsGroup"
      - "$ref": "#/components/schemas/ClusterEventViewForNdsGroup"
      - "$ref": "#/components/schemas/DataExplorerAccessedEventView"
      - "$ref": "#/components/schemas/DataExplorerEvent"
      - "$ref": "#/components/schemas/FTSIndexAuditView"
      - "$ref": "#/components/schemas/HostEventViewForNdsGroup"
      - "$ref": "#/components/schemas/HostMetricEvent"
      - "$ref": "#/components/schemas/NDSAuditViewForNdsGroup"
      - "$ref": "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup"
      - "$ref": "#/components/schemas/NDSServerlessInstanceAuditView"
      - "$ref": "#/components/schemas/NDSTenantEndpointAuditView"
      - "$ref": "#/components/schemas/ForNdsGroup"
      - "$ref": "#/components/schemas/SearchDeploymentAuditView"
      - "$ref": "#/components/schemas/TeamEventViewForNdsGroup"
      - "$ref": "#/components/schemas/UserEventViewForNdsGroup"
      - "$ref": "#/components/schemas/ResourceEventViewForNdsGroup"
      - "$ref": "#/components/schemas/StreamsEventViewForNdsGroup"
      - "$ref": "#/components/schemas/StreamProcessorEventViewForNdsGroup"
      - "$ref": "#/components/schemas/ChartsAudit"
      - "$ref": "#/components/schemas/AtlasResourcePolicyAuditForNdsGroup"
      type: object
    EventViewForOrg:
      oneOf:
      - "$ref": "#/components/schemas/DefaultEventViewForOrg"
      - "$ref": "#/components/schemas/AlertAudit"
      - "$ref": "#/components/schemas/AlertConfigAudit"
      - "$ref": "#/components/schemas/ApiUserEventViewForOrg"
      - "$ref": "#/components/schemas/ServiceAccountOrgEvents"
      - "$ref": "#/components/schemas/BillingEventViewForOrg"
      - "$ref": "#/components/schemas/NDSAuditViewForOrg"
      - "$ref": "#/components/schemas/OrgEventViewForOrg"
      - "$ref": "#/components/schemas/TeamEvent"
      - "$ref": "#/components/schemas/UserEventViewForOrg"
      - "$ref": "#/components/schemas/ResourceEventViewForOrg"
      - "$ref": "#/components/schemas/AtlasResourcePolicyAuditForOrg"
      type: object
    ExportStatus:
      description: State of the Export Job.
      properties:
        exportedCollections:
          description: Count of collections whose documents were exported to the Export
            Bucket.
          format: int32
          readOnly: true
          type: integer
        totalCollections:
          description: Total count of collections whose documents will be exported
            to the Export Bucket.
          format: int32
          readOnly: true
          type: integer
      type: object
    ExtraInfoPageFaultsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ExtraRetentionSetting:
      description: Extra retention setting item in the desired backup policy.
      properties:
        frequencyType:
          description: The frequency type for the extra retention settings for the
            cluster.
          enum:
          - HOURLY
          - DAILY
          - WEEKLY
          - MONTHLY
          - YEARLY
          - ON_DEMAND
          type: string
        retentionDays:
          description: The number of extra retention days for the cluster.
          format: int32
          type: integer
      type: object
    FTSIndexAuditTypeView:
      description: Unique identifier of event type.
      enum:
      - FTS_INDEX_DELETION_FAILED
      - FTS_INDEX_BUILD_COMPLETE
      - FTS_INDEX_BUILD_FAILED
      - FTS_INDEX_CREATED
      - FTS_INDEX_UPDATED
      - FTS_INDEX_DELETED
      - FTS_INDEX_CLEANED_UP
      - FTS_INDEX_STALE
      - FTS_INDEXES_RESTORED
      - FTS_INDEXES_RESTORE_FAILED
      - FTS_INDEXES_SYNONYM_MAPPING_INVALID
      example: FTS_INDEX_CREATED
      title: FTS Index Audit Types
      type: string
    FTSIndexAuditView:
      description: FTS index audit indicates any activities about search index.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/FTSIndexAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: FTS Index Audits
      type: object
    FTSMetric:
      description: Measurement of one Atlas Search status when MongoDB Atlas received
        this request.
      properties:
        metricName:
          description: Human-readable label that identifies this Atlas Search hardware,
            status, or index measurement.
          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
          - 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
          readOnly: true
          type: string
        units:
          description: Unit of measurement that applies to this Atlas Search metric.
          enum:
          - BYTES
          - BYTES_PER_SECOND
          - GIGABYTES
          - GIGABYTES_PER_HOUR
          - KILOBYTES
          - MEGABYTES
          - MEGABYTES_PER_SECOND
          - MILLISECONDS
          - MILLISECONDS_LOGSCALE
          - PERCENT
          - SCALAR
          - SCALAR_PER_SECOND
          - SECONDS
          readOnly: true
          type: string
      readOnly: true
      required:
      - metricName
      - units
      type: object
    FederatedUser:
      description: MongoDB Cloud user linked to this federated authentication.
      properties:
        emailAddress:
          description: Email address of the MongoDB Cloud user linked to the federated
            organization.
          format: email
          type: string
        federationSettingsId:
          description: Unique 24-hexadecimal digit string that identifies the federation
            to which this MongoDB Cloud user belongs.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        firstName:
          description: First or given name that belongs to the MongoDB Cloud user.
          type: string
        lastName:
          description: Last name, family name, or surname that belongs to the MongoDB
            Cloud user.
          type: string
        userId:
          description: Unique 24-hexadecimal digit string that identifies this user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      required:
      - emailAddress
      - federationSettingsId
      - firstName
      - lastName
      title: Federated User
      type: object
    FederationIdentityProvider:
      oneOf:
      - "$ref": "#/components/schemas/FederationSamlIdentityProvider"
      - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProvider"
      - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProvider"
      properties:
        associatedOrgs:
          description: List that contains the connected organization configurations
            associated with the identity provider.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfig"
          type: array
          uniqueItems: true
        createdAt:
          description: Date that the identity provider was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the identity
            provider.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          type: string
        oktaIdpId:
          description: Legacy 20-hexadecimal digit string that identifies the identity
            provider.
          pattern: "^([a-f0-9]{20})$"
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        updatedAt:
          description: Date that the identity provider was last updated on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
      required:
      - id
      - oktaIdpId
      type: object
    FederationIdentityProviderUpdate:
      oneOf:
      - "$ref": "#/components/schemas/FederationSamlIdentityProviderUpdate"
      - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate"
      - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate"
      properties:
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          maxLength: 50
          minLength: 1
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          example: urn:idp:default
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
      type: object
    FederationOidcIdentityProvider:
      oneOf:
      - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProvider"
      - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProvider"
      properties:
        associatedOrgs:
          description: List that contains the connected organization configurations
            associated with the identity provider.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfig"
          type: array
          uniqueItems: true
        audience:
          description: Identifier of the intended recipient of the token.
          type: string
        authorizationType:
          description: Indicates whether authorization is granted based on group membership
            or user ID.
          enum:
          - GROUP
          - USER
          type: string
        createdAt:
          description: Date that the identity provider was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          type: string
        groupsClaim:
          description: Identifier of the claim which contains IdP Group IDs in the
            token.
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the identity
            provider.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          type: string
        oktaIdpId:
          description: Legacy 20-hexadecimal digit string that identifies the identity
            provider.
          pattern: "^([a-f0-9]{20})$"
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        updatedAt:
          description: Date that the identity provider was last updated on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        userClaim:
          description: Identifier of the claim which contains the user ID in the token.
          type: string
      required:
      - id
      - oktaIdpId
      type: object
    FederationOidcIdentityProviderUpdate:
      oneOf:
      - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate"
      - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate"
      properties:
        audience:
          description: Identifier of the intended recipient of the token.
          type: string
        authorizationType:
          description: Indicates whether authorization is granted based on group membership
            or user ID.
          enum:
          - GROUP
          - USER
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          maxLength: 50
          minLength: 1
          type: string
        groupsClaim:
          description: Identifier of the claim which contains IdP Group IDs in the
            token.
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          example: urn:idp:default
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        userClaim:
          description: Identifier of the claim which contains the user ID in the token.
          type: string
      type: object
    FederationOidcWorkforceIdentityProvider:
      properties:
        associatedDomains:
          description: List that contains the domains associated with the identity
            provider.
          items:
            type: string
          type: array
          uniqueItems: true
        associatedOrgs:
          description: List that contains the connected organization configurations
            associated with the identity provider.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfig"
          type: array
          uniqueItems: true
        audience:
          description: Identifier of the intended recipient of the token.
          type: string
        authorizationType:
          description: Indicates whether authorization is granted based on group membership
            or user ID.
          enum:
          - GROUP
          - USER
          type: string
        clientId:
          description: Client identifier that is assigned to an application by the
            Identity Provider.
          type: string
        createdAt:
          description: Date that the identity provider was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          type: string
        groupsClaim:
          description: Identifier of the claim which contains IdP Group IDs in the
            token.
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the identity
            provider.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          type: string
        oktaIdpId:
          description: Legacy 20-hexadecimal digit string that identifies the identity
            provider.
          pattern: "^([a-f0-9]{20})$"
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        requestedScopes:
          description: Scopes that MongoDB applications will request from the authorization
            endpoint.
          items:
            type: string
          type: array
        updatedAt:
          description: Date that the identity provider was last updated on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        userClaim:
          description: Identifier of the claim which contains the user ID in the token.
          type: string
      required:
      - id
      - oktaIdpId
      title: OIDC WORKFORCE
      type: object
    FederationOidcWorkforceIdentityProviderUpdate:
      properties:
        associatedDomains:
          description: List that contains the domains associated with the identity
            provider.
          items:
            type: string
          type: array
          uniqueItems: true
        audience:
          description: Identifier of the intended recipient of the token.
          type: string
        authorizationType:
          description: Indicates whether authorization is granted based on group membership
            or user ID.
          enum:
          - GROUP
          - USER
          type: string
        clientId:
          description: Client identifier that is assigned to an application by the
            Identity Provider.
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          maxLength: 50
          minLength: 1
          type: string
        groupsClaim:
          description: Identifier of the claim which contains IdP Group IDs in the
            token.
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          example: urn:idp:default
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        requestedScopes:
          description: Scopes that MongoDB applications will request from the authorization
            endpoint.
          items:
            type: string
          type: array
        userClaim:
          description: Identifier of the claim which contains the user ID in the token.
          type: string
      title: OIDC WORKFORCE
      type: object
    FederationOidcWorkloadIdentityProvider:
      properties:
        associatedOrgs:
          description: List that contains the connected organization configurations
            associated with the identity provider.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfig"
          type: array
          uniqueItems: true
        audience:
          description: Identifier of the intended recipient of the token.
          type: string
        authorizationType:
          description: Indicates whether authorization is granted based on group membership
            or user ID.
          enum:
          - GROUP
          - USER
          type: string
        createdAt:
          description: Date that the identity provider was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          type: string
        groupsClaim:
          description: Identifier of the claim which contains IdP Group IDs in the
            token.
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the identity
            provider.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          type: string
        oktaIdpId:
          description: Legacy 20-hexadecimal digit string that identifies the identity
            provider.
          pattern: "^([a-f0-9]{20})$"
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        updatedAt:
          description: Date that the identity provider was last updated on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        userClaim:
          description: Identifier of the claim which contains the user ID in the token.
          type: string
      required:
      - id
      - oktaIdpId
      title: OIDC WORKLOAD
      type: object
    FederationOidcWorkloadIdentityProviderUpdate:
      properties:
        audience:
          description: Identifier of the intended recipient of the token.
          type: string
        authorizationType:
          description: Indicates whether authorization is granted based on group membership
            or user ID.
          enum:
          - GROUP
          - USER
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          maxLength: 50
          minLength: 1
          type: string
        groupsClaim:
          description: Identifier of the claim which contains IdP Group IDs in the
            token.
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          example: urn:idp:default
          type: string
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        userClaim:
          description: Identifier of the claim which contains the user ID in the token.
          type: string
      title: OIDC WORKLOAD
      type: object
    FederationSamlIdentityProvider:
      properties:
        acsUrl:
          description: URL that points to where to send the SAML response.
          type: string
        associatedDomains:
          description: List that contains the domains associated with the identity
            provider.
          items:
            type: string
          type: array
          uniqueItems: true
        associatedOrgs:
          description: List that contains the connected organization configurations
            associated with the identity provider.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfig"
          type: array
          uniqueItems: true
        audienceUri:
          description: Unique string that identifies the intended audience of the
            SAML assertion.
          type: string
        createdAt:
          description: Date that the identity provider was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the identity
            provider.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          type: string
        oktaIdpId:
          description: Legacy 20-hexadecimal digit string that identifies the identity
            provider.
          pattern: "^([a-f0-9]{20})$"
          type: string
        pemFileInfo:
          "$ref": "#/components/schemas/PemFileInfo"
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        requestBinding:
          description: SAML Authentication Request Protocol HTTP method binding (POST
            or REDIRECT) that Federated Authentication uses to send the authentication
            request.
          enum:
          - HTTP-POST
          - HTTP-REDIRECT
          type: string
        responseSignatureAlgorithm:
          description: Signature algorithm that Federated Authentication uses to encrypt
            the identity provider signature.
          enum:
          - SHA-1
          - SHA-256
          type: string
        slug:
          description: Custom SSO URL for the identity provider.
          type: string
        ssoDebugEnabled:
          description: Flag that indicates whether the identity provider has SSO debug
            enabled.
          type: boolean
        ssoUrl:
          description: URL that points to the receiver of the SAML authentication
            request.
          type: string
        status:
          description: String enum that indicates whether the identity provider is
            active.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
        updatedAt:
          description: Date that the identity provider was last updated on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
      required:
      - id
      - oktaIdpId
      title: SAML
      type: object
    FederationSamlIdentityProviderUpdate:
      properties:
        associatedDomains:
          description: List that contains the domains associated with the identity
            provider.
          items:
            type: string
          type: array
          uniqueItems: true
        description:
          description: The description of the identity provider.
          type: string
        displayName:
          description: Human-readable label that identifies the identity provider.
          maxLength: 50
          minLength: 1
          type: string
        idpType:
          description: String enum that indicates the type of the identity provider.
            Default is WORKFORCE.
          enum:
          - WORKFORCE
          - WORKLOAD
          type: string
        issuerUri:
          description: Unique string that identifies the issuer of the SAML Assertion
            or OIDC metadata/discovery document URL.
          example: urn:idp:default
          type: string
        pemFileInfo:
          "$ref": "#/components/schemas/PemFileInfoUpdate"
        protocol:
          description: String enum that indicates the protocol of the identity provider.
            Either SAML or OIDC.
          enum:
          - SAML
          - OIDC
          type: string
        requestBinding:
          description: SAML Authentication Request Protocol HTTP method binding (POST
            or REDIRECT) that Federated Authentication uses to send the authentication
            request.
          enum:
          - HTTP-POST
          - HTTP-REDIRECT
          type: string
        responseSignatureAlgorithm:
          description: Signature algorithm that Federated Authentication uses to encrypt
            the identity provider signature.
          enum:
          - SHA-1
          - SHA-256
          type: string
        slug:
          description: Custom SSO URL for the identity provider.
          type: string
        ssoDebugEnabled:
          description: Flag that indicates whether the identity provider has SSO debug
            enabled.
          type: boolean
        ssoUrl:
          description: URL that points to the receiver of the SAML authentication
            request.
          example: https://example.com
          type: string
        status:
          description: String enum that indicates whether the identity provider is
            active.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
      required:
      - ssoDebugEnabled
      title: SAML
      type: object
    FieldTransformation:
      description: Field Transformations during ingestion of a Data Lake Pipeline.
      properties:
        field:
          description: Key in the document.
          type: string
        type:
          description: Type of transformation applied during the export of the namespace
            in a Data Lake Pipeline.
          enum:
          - EXCLUDE
          type: string
      title: Field Transformation
      type: object
    FieldViolation:
      properties:
        description:
          description: A description of why the request element is bad.
          type: string
        field:
          description: A path that leads to a field in the request body.
          type: string
      required:
      - description
      - field
      type: object
    Fields:
      externalDocs:
        description: Atlas Search Field Mappings
        url: https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings
      type: object
    FlexAVGCommandExecutionTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    FlexAVGWriteExecutionTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    FlexBackupRestoreJob20241113:
      description: Details for one restore job of a flex cluster.
      properties:
        deliveryType:
          description: Means by which this resource returns the snapshot to the requesting
            MongoDB Cloud user.
          enum:
          - RESTORE
          - DOWNLOAD
          readOnly: true
          type: string
        expirationDate:
          description: Date and time when the download link no longer works. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the restore
            job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        instanceName:
          description: Human-readable label that identifies the source instance.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        projectId:
          description: Unique 24-hexadecimal digit string that identifies the project
            from which the restore job originated.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        restoreFinishedDate:
          description: Date and time when MongoDB Cloud completed writing this snapshot.
            MongoDB Cloud changes the status of the restore job to `CLOSED`. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        restoreScheduledDate:
          description: Date and time when MongoDB Cloud will restore this snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        snapshotFinishedDate:
          description: Date and time when MongoDB Cloud completed writing this snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        snapshotId:
          description: Unique 24-hexadecimal digit string that identifies the snapshot
            to restore.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        snapshotUrl:
          description: 'Internet address from which you can download the compressed
            snapshot files. The resource returns this parameter when  `"deliveryType"
            : "DOWNLOAD"`.'
          readOnly: true
          type: string
        status:
          description: Phase of the restore workflow for this job at the time this
            resource made this request.
          enum:
          - PENDING
          - QUEUED
          - RUNNING
          - FAILED
          - COMPLETED
          readOnly: true
          type: string
        targetDeploymentItemName:
          description: Human-readable label that identifies the instance or cluster
            on the target project to which you want to restore the snapshot. You can
            restore the snapshot to another flex or dedicated cluster tier.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          readOnly: true
          type: string
        targetProjectId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the instance or cluster to which you want to restore the
            snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      title: Flex Backup Restore Job
      type: object
    FlexBackupRestoreJobCreate20241113:
      description: Details to create one restore job of a flex cluster.
      properties:
        deliveryType:
          description: Means by which this resource returns the snapshot to the requesting
            MongoDB Cloud user.
          enum:
          - RESTORE
          - DOWNLOAD
          readOnly: true
          type: string
        expirationDate:
          description: Date and time when the download link no longer works. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the restore
            job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        instanceName:
          description: Human-readable label that identifies the source instance.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        projectId:
          description: Unique 24-hexadecimal digit string that identifies the project
            from which the restore job originated.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        restoreFinishedDate:
          description: Date and time when MongoDB Cloud completed writing this snapshot.
            MongoDB Cloud changes the status of the restore job to `CLOSED`. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        restoreScheduledDate:
          description: Date and time when MongoDB Cloud will restore this snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        snapshotFinishedDate:
          description: Date and time when MongoDB Cloud completed writing this snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        snapshotId:
          description: Unique 24-hexadecimal digit string that identifies the snapshot
            to restore.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
        snapshotUrl:
          description: 'Internet address from which you can download the compressed
            snapshot files. The resource returns this parameter when  `"deliveryType"
            : "DOWNLOAD"`.'
          readOnly: true
          type: string
        status:
          description: Phase of the restore workflow for this job at the time this
            resource made this request.
          enum:
          - PENDING
          - QUEUED
          - RUNNING
          - FAILED
          - COMPLETED
          readOnly: true
          type: string
        targetDeploymentItemName:
          description: Human-readable label that identifies the instance or cluster
            on the target project to which you want to restore the snapshot. You can
            restore the snapshot to another flex cluster or dedicated cluster tier.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
          writeOnly: true
        targetProjectId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the instance or cluster to which you want to restore the
            snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
      required:
      - snapshotId
      - targetDeploymentItemName
      title: Create Flex Backup Restore Job
      type: object
    FlexBackupSettings20241113:
      description: Flex backup configuration.
      properties:
        enabled:
          default: true
          description: Flag that indicates whether backups are performed for this
            flex cluster. Backup uses flex cluster backups.
          externalDocs:
            description: Flex Cluster Backups
            url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/flex-cluster-backup/
          readOnly: true
          type: boolean
      readOnly: true
      title: Flex Backup Configuration
      type: object
    FlexBackupSnapshot20241113:
      description: Details for one snapshot of a flex cluster.
      properties:
        expiration:
          description: Date and time when the download link no longer works. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        finishTime:
          description: Date and time when MongoDB Cloud completed writing this snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBVersion:
          description: MongoDB host version that the snapshot runs.
          readOnly: true
          type: string
        scheduledTime:
          description: Date and time when MongoDB Cloud will take the snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        startTime:
          description: Date and time when MongoDB Cloud began taking the snapshot.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        status:
          description: Phase of the workflow for this snapshot at the time this resource
            made this request.
          enum:
          - PENDING
          - QUEUED
          - RUNNING
          - FAILED
          - COMPLETED
          readOnly: true
          type: string
      title: Flex Backup Snapshot
      type: object
    FlexBackupSnapshotDownloadCreate20241113:
      description: Details for one backup snapshot download of a flex cluster.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        snapshotId:
          description: Unique 24-hexadecimal digit string that identifies the snapshot
            to download.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
      required:
      - snapshotId
      title: Flex Backup Snapshot Download Create
      type: object
    FlexClusterDescription20241113:
      description: Group of settings that configure a MongoDB Flex cluster.
      properties:
        backupSettings:
          "$ref": "#/components/schemas/FlexBackupSettings20241113"
        clusterType:
          default: REPLICASET
          description: Flex cluster topology.
          enum:
          - REPLICASET
          readOnly: true
          type: string
        connectionStrings:
          "$ref": "#/components/schemas/FlexConnectionStrings20241113"
        createDate:
          description: Date and time when MongoDB Cloud created this instance. This
            parameter expresses its value in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the instance.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBVersion:
          description: Version of MongoDB that the instance runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the instance.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        providerSettings:
          "$ref": "#/components/schemas/FlexProviderSettings20241113"
        stateName:
          description: |-
            Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

             - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
             - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
             - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
             - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
             - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the instance.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
        versionReleaseSystem:
          default: LTS
          description: Method by which the cluster maintains the MongoDB versions.
          enum:
          - LTS
          readOnly: true
          type: string
      required:
      - providerSettings
      title: Flex Cluster Description
      type: object
    FlexClusterDescriptionCreate20241113:
      description: Settings that you can specify when you create a flex cluster.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the instance.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
          writeOnly: true
        providerSettings:
          "$ref": "#/components/schemas/FlexProviderSettingsCreate20241113"
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the instance.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
      required:
      - name
      - providerSettings
      title: Flex Cluster Description Create
      type: object
    FlexClusterDescriptionUpdate20241113:
      description: Settings that you can specify when you update a flex cluster.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the instance.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
      title: Flex Cluster Description Update
      type: object
    FlexClusterMetricThreshold:
      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 about the serverless database.
      discriminator:
        mapping:
          FLEX_AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/FlexAVGCommandExecutionTimeMetricThresholdView"
          FLEX_AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView"
          FLEX_AVG_WRITE_EXECUTION_TIME: "#/components/schemas/FlexAVGWriteExecutionTimeMetricThresholdView"
          FLEX_CONNECTIONS: "#/components/schemas/RawMetricThresholdView"
          FLEX_CONNECTIONS_PERCENT: "#/components/schemas/FlexConnectionPercentRawMetricThresholdView"
          FLEX_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricThresholdView"
          FLEX_NETWORK_BYTES_IN: "#/components/schemas/FlexNetworkBytesInDataMetricThresholdView"
          FLEX_NETWORK_BYTES_OUT: "#/components/schemas/FlexNetworkBytesOutDataMetricThresholdView"
          FLEX_NETWORK_NUM_REQUESTS: "#/components/schemas/FlexNetworkNumRequestsRawMetricThresholdView"
          FLEX_OPCOUNTER_CMD: "#/components/schemas/FlexOpCounterCMDRawMetricThresholdView"
          FLEX_OPCOUNTER_DELETE: "#/components/schemas/FlexOpCounterDeleteRawMetricThresholdView"
          FLEX_OPCOUNTER_GETMORE: "#/components/schemas/FlexOpCounterGetMoreRawMetricThresholdView"
          FLEX_OPCOUNTER_INSERT: "#/components/schemas/FlexOpCounterInsertRawMetricThresholdView"
          FLEX_OPCOUNTER_QUERY: "#/components/schemas/FlexOpCounterQueryRawMetricThresholdView"
          FLEX_OPCOUNTER_UPDATE: "#/components/schemas/FlexOpCounterUpdateRawMetricThresholdView"
        propertyName: metricName
      oneOf:
      - "$ref": "#/components/schemas/RawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexConnectionPercentRawMetricThresholdView"
      - "$ref": "#/components/schemas/DataMetricThresholdView"
      - "$ref": "#/components/schemas/FlexNetworkBytesInDataMetricThresholdView"
      - "$ref": "#/components/schemas/FlexNetworkBytesOutDataMetricThresholdView"
      - "$ref": "#/components/schemas/FlexNetworkNumRequestsRawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexOpCounterCMDRawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexOpCounterDeleteRawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexOpCounterInsertRawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexOpCounterQueryRawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexOpCounterUpdateRawMetricThresholdView"
      - "$ref": "#/components/schemas/FlexOpCounterGetMoreRawMetricThresholdView"
      - "$ref": "#/components/schemas/TimeMetricThresholdView"
      - "$ref": "#/components/schemas/FlexAVGWriteExecutionTimeMetricThresholdView"
      - "$ref": "#/components/schemas/FlexAVGCommandExecutionTimeMetricThresholdView"
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      required:
      - metricName
      title: Flex Cluster Metric Threshold
      type: object
    FlexConnectionPercentRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexConnectionStrings20241113:
      description: Collection of Uniform Resource Locators that point to the MongoDB
        database.
      externalDocs:
        description: Connection string URI format.
        url: https://docs.mongodb.com/manual/reference/connection-string/
      properties:
        standard:
          description: Public connection string that you can use to connect to this
            cluster. This connection string uses the `mongodb://` protocol.
          externalDocs:
            description: Connection String URI Format
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        standardSrv:
          description: Public connection string that you can use to connect to this
            flex cluster. This connection string uses the `mongodb+srv://` protocol.
          externalDocs:
            description: Connection String URI Format
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
      readOnly: true
      title: Flex Cluster Connection Strings
      type: object
    FlexMetricAlertConfigViewForNdsGroup:
      description: Flex metric alert configuration allows to select which Flex database
        metrics trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/FlexMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        metricThreshold:
          "$ref": "#/components/schemas/FlexClusterMetricThreshold"
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Flex Alert Configuration
      type: object
    FlexMetricEventTypeViewAlertable:
      description: Event type that triggers an alert.
      enum:
      - OUTSIDE_FLEX_METRIC_THRESHOLD
      example: OUTSIDE_FLEX_METRIC_THRESHOLD
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Flex Metric Event Types
      type: string
    FlexNetworkBytesInDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FlexNetworkBytesOutDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FlexNetworkNumRequestsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexOpCounterCMDRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexOpCounterDeleteRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexOpCounterGetMoreRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexOpCounterInsertRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexOpCounterQueryRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexOpCounterUpdateRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FlexProviderSettings20241113:
      description: Group of cloud provider settings that configure the provisioned
        MongoDB flex cluster.
      properties:
        backingProviderName:
          description: Cloud service provider on which MongoDB Cloud provisioned the
            flex cluster.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        diskSizeGB:
          description: Storage capacity available to the flex cluster expressed in
            gigabytes.
          format: double
          readOnly: true
          type: number
        providerName:
          default: FLEX
          description: Human-readable label that identifies the provider type.
          enum:
          - FLEX
          readOnly: true
          type: string
        regionName:
          description: Human-readable label that identifies the geographic location
            of your MongoDB flex cluster. The region you choose can affect network
            latency for clients accessing your databases. For a complete list of region
            names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
            [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
          readOnly: true
          type: string
      readOnly: true
      title: Cloud Service Provider Settings for a Flex Cluster
      type: object
    FlexProviderSettingsCreate20241113:
      description: Group of cloud provider settings that configure the provisioned
        MongoDB flex cluster.
      properties:
        backingProviderName:
          description: Cloud service provider on which MongoDB Cloud provisioned the
            flex cluster.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
          writeOnly: true
        diskSizeGB:
          description: Storage capacity available to the flex cluster expressed in
            gigabytes.
          format: double
          readOnly: true
          type: number
        providerName:
          default: FLEX
          description: Human-readable label that identifies the provider type.
          enum:
          - FLEX
          readOnly: true
          type: string
        regionName:
          description: Human-readable label that identifies the geographic location
            of your MongoDB flex cluster. The region you choose can affect network
            latency for clients accessing your databases. For a complete list of region
            names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
            [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
          type: string
          writeOnly: true
      required:
      - backingProviderName
      - regionName
      title: Cloud Service Provider Settings for a Flex Cluster
      type: object
      writeOnly: true
    ForNdsGroup:
      description: Replica Set Event identifies different activities about replica
        set of mongod instances.
      properties:
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        raw:
          "$ref": "#/components/schemas/raw"
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: ReplicaSet Events
      type: object
    FreeComputeAutoScalingRules:
      description: Collection of settings that configures how a cluster might scale
        its cluster tier and whether the cluster can scale down.
      properties:
        maxInstanceSize:
          description: Maximum instance size to which your cluster can automatically
            scale.
          enum:
          - M0
          - M2
          - M5
          title: Tenant Instance Sizes
          type: string
        minInstanceSize:
          description: Minimum instance size to which your cluster can automatically
            scale.
          enum:
          - M0
          - M2
          - M5
          title: Tenant Instance Sizes
          type: string
      title: Tenant
      type: object
    FtsDiskUtilizationDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FtsJvmCurrentMemoryDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FtsJvmMaxMemoryDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FtsMemoryMappedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FtsMemoryResidentDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FtsMemoryVirtualDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    FtsProcessCpuKernelRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    FtsProcessCpuUserRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GCPAccountDetails:
      properties:
        cidrBlock:
          description: The VPC CIDR Block.
          type: string
        cloudProvider:
          description: Cloud provider.
          type: string
        gcpProjectId:
          description: The GCP Project ID.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        vpcNetworkName:
          description: The name of the VPC network.
          type: string
      type: object
    GCPCloudProviderContainer:
      allOf:
      - "$ref": "#/components/schemas/CloudProviderContainer"
      - properties:
          atlasCidrBlock:
            description: |-
              IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

              These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.

              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 Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.
            pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
            type: string
          gcpProjectId:
            description: Unique string that identifies the GCP project in which MongoDB
              Cloud clusters in this network peering container exist. The response
              returns **null** if no clusters exist in this network peering container.
            pattern: "^p-[0-9a-z]{24}$"
            readOnly: true
            type: string
          networkName:
            description: Human-readable label that identifies the network in which
              MongoDB Cloud clusters in this network peering container exist. MongoDB
              Cloud returns **null** if no clusters exist in this network peering
              container.
            pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$"
            readOnly: true
            type: string
          regions:
            description: List of GCP regions to which you want to deploy this MongoDB
              Cloud network peering container.  In this MongoDB Cloud project, you
              can deploy clusters only to the GCP regions in this list. To deploy
              MongoDB Cloud clusters to other GCP regions, create additional projects.
            items:
              description: List of GCP regions to which you want to deploy this MongoDB
                Cloud network peering container.  In this MongoDB Cloud project, you
                can deploy clusters only to the GCP regions in this list. To deploy
                MongoDB Cloud clusters to other GCP regions, create additional projects.
              enum:
              - AFRICA_SOUTH_1
              - ASIA_EAST_2
              - ASIA_NORTHEAST_2
              - ASIA_NORTHEAST_3
              - ASIA_SOUTH_1
              - ASIA_SOUTH_2
              - ASIA_SOUTHEAST_2
              - AUSTRALIA_SOUTHEAST_1
              - AUSTRALIA_SOUTHEAST_2
              - CENTRAL_US
              - EASTERN_ASIA_PACIFIC
              - EASTERN_US
              - EUROPE_CENTRAL_2
              - EUROPE_NORTH_1
              - EUROPE_WEST_2
              - EUROPE_WEST_3
              - EUROPE_WEST_4
              - EUROPE_WEST_6
              - EUROPE_WEST_10
              - EUROPE_WEST_12
              - MIDDLE_EAST_CENTRAL_1
              - MIDDLE_EAST_CENTRAL_2
              - MIDDLE_EAST_WEST_1
              - NORTH_AMERICA_NORTHEAST_1
              - NORTH_AMERICA_NORTHEAST_2
              - NORTH_AMERICA_SOUTH_1
              - NORTHEASTERN_ASIA_PACIFIC
              - SOUTH_AMERICA_EAST_1
              - SOUTH_AMERICA_WEST_1
              - SOUTHEASTERN_ASIA_PACIFIC
              - US_EAST_4
              - US_EAST_5
              - US_WEST_2
              - US_WEST_3
              - US_WEST_4
              - US_SOUTH_1
              - WESTERN_EUROPE
              - WESTERN_US
              type: string
            type: array
        type: object
      description: Collection of settings that configures the network container for
        a virtual private connection on Amazon Web Services.
      required:
      - atlasCidrBlock
      - regions
      title: GCP
      type: object
    GCPComputeAutoScaling:
      description: Collection of settings that configures how a cluster might scale
        its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling
        is unavailable for clusters using Low CPU or NVME storage classes.
      properties:
        maxInstanceSize:
          description: Maximum instance size to which your cluster can automatically
            scale.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M140
          - M200
          - M250
          - M300
          - M400
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - R600
          title: GCP Instance Sizes
          type: string
        minInstanceSize:
          description: Minimum instance size to which your cluster can automatically
            scale.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M140
          - M200
          - M250
          - M300
          - M400
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - R600
          title: GCP Instance Sizes
          type: string
      title: GCP
      type: object
    GCPConsumerForwardingRule:
      properties:
        endpointName:
          description: Human-readable label that identifies the Google Cloud consumer
            forwarding rule that you created.
          externalDocs:
            description: Google Cloud Forwarding Rule Concepts
            url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts
          readOnly: true
          type: string
        ipAddress:
          description: One Private Internet Protocol version 4 (IPv4) address to which
            this Google Cloud consumer forwarding rule resolves.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
          type: string
        status:
          description: State of the MongoDB Cloud endpoint group when MongoDB Cloud
            received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
          type: string
      type: object
    GCPCreateDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/CreateDataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you wish to store your archived data.
            enum:
            - CENTRAL_US
            - WESTERN_EUROPE
            type: string
        type: object
      type: object
    GCPDataProcessRegionView:
      allOf:
      - "$ref": "#/components/schemas/DataProcessRegionView"
      - properties:
          region:
            description: Human-readable label that identifies the geographic location
              of the region where you store your archived data.
            enum:
            - CENTRAL_US
            - WESTERN_EUROPE
            readOnly: true
            type: string
        type: object
      type: object
    GCPEndpointService:
      description: Group of Private Endpoint Service settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint service.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        endpointGroupNames:
          description: List of Google Cloud network endpoint groups that corresponds
            to the Private Service Connect endpoint service. If this endpoint service
            uses PSC port-mapping, this field will only contain a list of one endpoint.
          externalDocs:
            description: Google Cloud Forwarding Rule Concepts
            url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts
          items:
            description: One Google Cloud network endpoint group that corresponds
              to the Private Service Connect endpoint service.
            type: string
          type: array
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        portMappingEnabled:
          description: Flag that indicates whether this endpoint service uses PSC
            port-mapping.
          type: boolean
        regionName:
          description: Cloud provider region that manages this Private Endpoint Service.
          readOnly: true
          type: string
        serviceAttachmentNames:
          description: List of Uniform Resource Locators (URLs) that identifies endpoints
            that MongoDB Cloud can use to access one Google Cloud Service across a
            Google Cloud Virtual Private Connection (VPC) network. If this endpoint
            service uses PSC port-mapping, this field will only contain a list of
            one service attachment.
          externalDocs:
            description: Google Cloud Private Service Connect Service Attachments
            url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments
          items:
            description: Uniform Resource Locator (URL) that identifies one endpoint
              that MongoDB Cloud can use to access one Google Cloud Service across
              a Google Cloud Virtual Private Connection (VPC) network.
            pattern: https:\/\/([a-z0-9\.]+)+\.[a-z]{2,}(\/[a-z0-9\-]+)+\/projects\/p-[a-z0-9]+\/regions\/[a-z\-0-9]+\/serviceAttachments\/[a-z0-9\-]+
            type: string
          type: array
        status:
          description: State of the Private Endpoint Service connection when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - AVAILABLE
          - WAITING_FOR_USER
          - FAILED
          - DELETING
          readOnly: true
          type: string
      required:
      - cloudProvider
      title: GCP
      type: object
    GCPHardwareSpec20240805:
      properties:
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value must be equal for
            all shards and node types.\n\n This value is not configurable on M0/M2/M5
            clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n
            If you specify a disk size below the minimum (10 GB), this parameter defaults
            to the minimum disk size value. \n\n Storage charge calculations depend
            on whether you choose the default value or a custom value.\n\n The maximum
            value for disk storage cannot exceed 50 times the maximum RAM for the
            selected cluster. If you require more storage space, consider upgrading
            your cluster to a higher tier."
          externalDocs:
            description: Customize Storage
            url: https://dochub.mongodb.org/core/customize-storage
          format: double
          type: number
        instanceSize:
          description: Hardware specification for the instance sizes in this region
            in this shard. Each instance size has a default storage and memory capacity.
            Electable nodes and read-only nodes (known as "base nodes") within a single
            shard must use the same instance size. Analytics nodes can scale independently
            from base nodes within a shard. Both base nodes and analytics nodes can
            scale independently from their equivalents in other shards.
          enum:
          - M10
          - M20
          - M30
          - M40
          - M50
          - M60
          - M80
          - M140
          - M200
          - M250
          - M300
          - M400
          - R40
          - R50
          - R60
          - R80
          - R200
          - R300
          - R400
          - R600
          title: GCP Instance Sizes
          type: string
        nodeCount:
          description: Number of nodes of the given type for MongoDB Cloud to deploy
            to the region.
          format: int32
          type: integer
      type: object
    GCPNetworkPeeringConnectionSettings:
      description: Group of Network Peering connection settings.
      properties:
        containerId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud network container that contains the specified network peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        errorMessage:
          description: Details of the error returned when requesting a GCP network
            peering resource. The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        gcpProjectId:
          description: Human-readable label that identifies the GCP project that contains
            the network that you want to peer with the MongoDB Cloud VPC.
          pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}"
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the network
            peering connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        networkName:
          description: Human-readable label that identifies the network to peer with
            the MongoDB Cloud VPC.
          pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?"
          type: string
        providerName:
          description: Cloud service provider that serves the requested network peering
            connection.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        status:
          description: State of the network peering connection at the time you made
            the request.
          enum:
          - ADDING_PEER
          - WAITING_FOR_USER
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
          type: string
      required:
      - containerId
      - gcpProjectId
      - networkName
      title: GCP
      type: object
    GCPRegionConfig20240805:
      allOf:
      - "$ref": "#/components/schemas/CloudRegionConfig20240805"
      - properties:
          analyticsAutoScaling:
            "$ref": "#/components/schemas/AdvancedAutoScalingSettings"
          analyticsSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          autoScaling:
            "$ref": "#/components/schemas/AdvancedAutoScalingSettings"
          effectiveAnalyticsSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          effectiveElectableSpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          effectiveReadOnlySpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
          readOnlySpecs:
            "$ref": "#/components/schemas/DedicatedHardwareSpec20240805"
        type: object
      description: Details that explain how MongoDB Cloud replicates data in one region
        on the specified MongoDB database.
      title: GCP Regional Replication Specifications
      type: object
    GcsLogIntegrationRequest:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationRequest"
      - properties:
          bucketName:
            description: Name of the bucket to store log files.
            example: my-gcs-log-bucket
            type: string
          prefixPath:
            description: Path prefix where the log files will be stored. Atlas will
              add further sub-directories based on the log type.
            example: mongodb-logs/
            type: string
          roleId:
            description: Unique 24-character hexadecimal string that identifies the
              Atlas Cloud Provider Access role.
            example: 507f1f77bcf86cd799439011
            pattern: "^[a-fA-F0-9]{24}$"
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - GCS_LOG_EXPORT
            type: string
        type: object
      description: Request schema for creating or updating a Google Cloud Storage
        log export integration.
      required:
      - bucketName
      - logTypes
      - prefixPath
      - roleId
      - type
      title: GCS Log Export Integration Request
      type: object
    GcsLogIntegrationResponse:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationResponse"
      - properties:
          bucketName:
            description: Name of the bucket to store log files.
            example: my-gcs-log-bucket
            type: string
          prefixPath:
            description: Path prefix where the log files will be stored. Atlas will
              add further sub-directories based on the log type.
            example: mongodb-logs/
            type: string
          roleId:
            description: Unique 24-character hexadecimal string that identifies the
              Atlas Cloud Provider Access role.
            example: 507f1f77bcf86cd799439011
            pattern: "^[a-fA-F0-9]{24}$"
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - GCS_LOG_EXPORT
            type: string
        type: object
      description: Details to integrate Google Cloud Storage log export with one Atlas
        project.
      required:
      - bucketName
      - id
      - logTypes
      - prefixPath
      - roleId
      - type
      title: GCS Log Export Integration Response
      type: object
    GeoSharding20240805:
      properties:
        customZoneMapping:
          additionalProperties:
            description: |-
              List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.

               The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.

              This parameter returns an empty object if no custom zones exist.

              Example: `{"US-VA": "6716c5a804f4ce77e899bf99", "DE": "6716c5a804f4ce77e899bf9a"}`.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          description: |-
            List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.

             The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.

            This parameter returns an empty object if no custom zones exist.

            Example: `{"US-VA": "6716c5a804f4ce77e899bf99", "DE": "6716c5a804f4ce77e899bf9a"}`.
          readOnly: true
          type: object
        managedNamespaces:
          description: List that contains a namespace for a Global Cluster. MongoDB
            Cloud manages this cluster.
          items:
            "$ref": "#/components/schemas/ManagedNamespaces"
          readOnly: true
          type: array
        selfManagedSharding:
          description: Boolean that controls which management mode the Global Cluster
            is operating under. If this parameter is true Self-Managed Sharding is
            enabled and users are in control of the zone sharding within the Global
            Cluster. If this parameter is false Atlas-Managed Sharding is enabled
            and Atlas is control of zone sharding within the Global Cluster.
          readOnly: true
          type: boolean
      type: object
    GlobalAccessesNotInMemoryRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GlobalLockCurrentQueueReadersRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GlobalLockCurrentQueueTotalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GlobalLockCurrentQueueWritersRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GlobalLockPercentageRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GlobalPageFaultExceptionsThrownRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    GoogleCloudKMS:
      description: Details that define the configuration of Encryption at Rest using
        Google Cloud Key Management Service (KMS).
      externalDocs:
        description: Google Cloud Key Management Service
        url: https://www.mongodb.com/docs/atlas/security-gcp-kms/
      properties:
        enabled:
          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`.
          type: boolean
        keyVersionResourceID:
          description: Resource path that displays the key version resource ID for
            your Google Cloud KMS.
          example: projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1
          type: string
        roleId:
          description: Unique 24-hexadecimal digit string that identifies the Google
            Cloud Provider Access Role that MongoDB Cloud uses to access the Google
            Cloud KMS.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        serviceAccountKey:
          description: JavaScript Object Notation (JSON) object that contains the
            Google Cloud Key Management Service (KMS). Format the JSON as a string
            and not as an object.
          externalDocs:
            description: Google Cloud Authentication
            url: https://cloud.google.com/docs/authentication/getting-started
          type: string
          writeOnly: true
        valid:
          description: Flag that indicates whether the Google Cloud Key Management
            Service (KMS) encryption key can encrypt and decrypt data.
          readOnly: true
          type: boolean
      type: object
    GreaterThanDaysThresholdView:
      description: Threshold value that triggers an alert.
      properties:
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: int32
          type: integer
        units:
          description: Element used to express the quantity. This can be an element
            of time, storage capacity, and the like.
          enum:
          - DAYS
          type: string
      type: object
    GreaterThanRawThreshold:
      description: A Limit that triggers an alert when greater than a number.
      properties:
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: int32
          type: integer
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      title: Greater Than Raw Threshold
      type: object
    GreaterThanRawThresholdAlertConfigViewForNdsGroup:
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/ReplicaSetMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/GreaterThanRawThreshold"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      type: object
    GreaterThanTimeThreshold:
      description: A Limit that triggers an alert when greater than a time period.
      properties:
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: int32
          type: integer
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      title: Greater Than Time Threshold
      type: object
    Group:
      properties:
        clusterCount:
          description: Quantity of MongoDB Cloud clusters deployed in this project.
          format: int64
          readOnly: true
          type: integer
        created:
          description: Date and time when MongoDB Cloud created this project. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the project included in
            the MongoDB Cloud organization.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud organization to which the project belongs.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        regionUsageRestrictions:
          default: COMMERCIAL_FEDRAMP_REGIONS_ONLY
          description: |-
            Applies to Atlas for Government only.

            In Commercial Atlas, this field will be rejected in requests and missing in responses.

            This field sets restrictions on available regions in the project.

            `COMMERCIAL_FEDRAMP_REGIONS_ONLY`: Only allows deployments in FedRAMP Moderate regions.

            `GOV_REGIONS_ONLY`: Only allows deployments in GovCloud regions.
          enum:
          - COMMERCIAL_FEDRAMP_REGIONS_ONLY
          - GOV_REGIONS_ONLY
          externalDocs:
            url: https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the project.
          externalDocs:
            description: Resource Tags
            url: https://www.mongodb.com/docs/atlas/tags
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        withDefaultAlertsSettings:
          default: true
          description: Flag that indicates whether to create the project with default
            alert settings.
          type: boolean
      required:
      - clusterCount
      - created
      - name
      - orgId
      type: object
    GroupActiveUserResponse:
      allOf:
      - "$ref": "#/components/schemas/GroupUserResponse"
      - properties:
          country:
            description: Two-character alphabetical string that identifies the MongoDB
              Cloud user's geographic location. This parameter uses the ISO 3166-1a2
              code format.
            example: US
            pattern: "^([A-Z]{2})$"
            readOnly: true
            type: string
          createdAt:
            description: Date and time when MongoDB Cloud created the current account.
              This value is in the ISO 8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          firstName:
            description: First or given name that belongs to the MongoDB Cloud user.
            example: John
            readOnly: true
            type: string
          lastAuth:
            description: Date and time when the current account last authenticated.
              This value is in the ISO 8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          lastName:
            description: Last name, family name, or surname that belongs to the MongoDB
              Cloud user.
            example: Doe
            readOnly: true
            type: string
          mobileNumber:
            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})$"
            readOnly: true
            type: string
        type: object
      required:
      - createdAt
      - firstName
      - id
      - lastName
      - orgMembershipStatus
      - roles
      - username
      type: object
    GroupAlertsConfig:
      oneOf:
      - "$ref": "#/components/schemas/DefaultAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/AppServiceAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/ClusterAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/HostAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/HostMetricAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/MongotuneAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/FlexMetricAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup"
      - "$ref": "#/components/schemas/StreamProcessorMetricAlertConfigViewForNdsGroup"
      type: object
    GroupIPAddresses:
      description: List of IP addresses in a project.
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        services:
          "$ref": "#/components/schemas/GroupService"
      title: Group IP Address
      type: object
    GroupInvitation:
      properties:
        createdAt:
          description: Date and time when MongoDB Cloud sent the invitation. This
            parameter expresses its value in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        expiresAt:
          description: Date and time when MongoDB Cloud expires the invitation. This
            parameter expresses its value in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        groupName:
          description: Human-readable label that identifies the project to which you
            invited the MongoDB Cloud user.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            invitation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        inviterUsername:
          description: Email address of the MongoDB Cloud user who sent the invitation.
          format: email
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        roles:
          description: One or more organization or project level roles to assign to
            the MongoDB Cloud user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
        username:
          description: Email address of the MongoDB Cloud user invited to join the
            project.
          format: email
          readOnly: true
          type: string
      type: object
    GroupInvitationRequest:
      properties:
        roles:
          description: One or more project level roles to assign to the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
        username:
          description: Email address of the MongoDB Cloud user invited to the specified
            project.
          format: email
          type: string
      type: object
    GroupInvitationUpdateRequest:
      properties:
        roles:
          description: One or more project-level roles to assign to the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    GroupMaintenanceWindow:
      properties:
        autoDeferOnceEnabled:
          description: Flag that indicates whether MongoDB Cloud should defer all
            maintenance windows for one week after you enable them. This setting controls
            the same underlying auto-deferral feature as the `/maintenanceWindow/autoDefer`
            endpoint. Use either this field (to set a specific value) or that endpoint
            (to toggle the current value). For most use cases, this field in the PATCH
            request is preferred because it allows setting an explicit value rather
            than toggling.
          type: boolean
        dayOfWeek:
          description: |-
            One-based integer that represents the day of the week that the maintenance window starts.

            - `1`: Sunday.
            - `2`: Monday.
            - `3`: Tuesday.
            - `4`: Wednesday.
            - `5`: Thursday.
            - `6`: Friday.
            - `7`: Saturday.
          format: int32
          maximum: 7
          minimum: 1
          type: integer
        hourOfDay:
          description: Zero-based integer that represents the hour of the of the day
            that the maintenance window starts according to a 24-hour clock. Use `0`
            for midnight and `12` for noon.
          format: int32
          maximum: 23
          minimum: 0
          type: integer
        numberOfDeferrals:
          description: Number of times the current maintenance event for this project
            has been deferred.
          format: int32
          readOnly: true
          type: integer
        protectedHours:
          "$ref": "#/components/schemas/ProtectedHours"
        startASAP:
          description: Flag that indicates whether MongoDB Cloud starts the maintenance
            window immediately upon receiving this request. To start the maintenance
            window immediately for your project, MongoDB Cloud must have maintenance
            scheduled and you must set a maintenance window. This flag resets to `false`
            after MongoDB Cloud completes maintenance.
          type: boolean
        timeZoneId:
          description: Identifier for the current time zone of the maintenance window.
            This can only be updated via the Project Settings UI.
          readOnly: true
          type: string
      required:
      - dayOfWeek
      type: object
    GroupMigrationRequest:
      properties:
        destinationOrgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to move the specified project to.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        destinationOrgPrivateApiKey:
          description: Unique string that identifies the private part of the API Key
            used to verify access to the destination organization. This parameter
            is required only when you authenticate with Programmatic API Keys.
          example: 55c3bbb6-b4bb-0be1-e66d20841f3e
          externalDocs:
            description: Grant Programmatic Access to Atlas
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          type: string
        destinationOrgPublicApiKey:
          description: Unique string that identifies the public part of the API Key
            used to verify access to the destination organization. This parameter
            is required only when you authenticate with Programmatic API Keys.
          example: zmmrboas
          externalDocs:
            description: Grant Programmatic Access to Atlas
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          maxLength: 8
          minLength: 8
          type: string
      type: object
    GroupNotification:
      description: Group notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        emailEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        roles:
          description: 'List that contains the one or more project roles that receive
            the configured alert. This parameter is available when `"notifications.[n].typeName"
            : "GROUP"` or `"notifications.[n].typeName" : "ORG"`. If you include this
            parameter, MongoDB Cloud sends alerts only to users assigned the roles
            you specify in the array. If you omit this parameter, MongoDB Cloud sends
            alerts to users assigned any role.'
          externalDocs:
            description: Project Roles
            url: https://dochub.mongodb.org/core/atlas-proj-roles
          items:
            description: One or more project roles that receive the configured alert.
            type: string
          type: array
        smsEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - GROUP
          type: string
      required:
      - typeName
      title: Group Notification
      type: object
    GroupPaginatedEventView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/EventViewForNdsGroup"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    GroupPendingUserResponse:
      allOf:
      - "$ref": "#/components/schemas/GroupUserResponse"
      - properties:
          invitationCreatedAt:
            description: Date and time when MongoDB Cloud sent the invitation. MongoDB
              Cloud represents this timestamp in ISO 8601 format in UTC.
            format: date-time
            readOnly: true
            type: string
          invitationExpiresAt:
            description: Date and time when the invitation from MongoDB Cloud expires.
              MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
            format: date-time
            readOnly: true
            type: string
          inviterUsername:
            description: Username of the MongoDB Cloud user who sent the invitation
              to join the organization.
            format: email
            readOnly: true
            type: string
        type: object
      required:
      - id
      - invitationCreatedAt
      - invitationExpiresAt
      - inviterUsername
      - orgMembershipStatus
      - roles
      - username
      type: object
    GroupRole:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to which this role belongs.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        groupRole:
          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 project-level roles.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/#project-roles
          type: string
      type: object
    GroupRoleAssignment:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to which these roles belong.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        groupRoles:
          description: One or more project-level roles assigned to the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    GroupService:
      description: List of IP addresses in a project categorized by services.
      properties:
        clusters:
          description: IP addresses of clusters.
          items:
            "$ref": "#/components/schemas/ClusterIPAddresses"
          readOnly: true
          type: array
      readOnly: true
      title: Group Service IP Addresses
      type: object
    GroupServiceAccount:
      properties:
        clientId:
          description: The Client ID of the Service Account.
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
        createdAt:
          description: The date that the Service Account was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        description:
          description: Human readable description for the Service Account.
          type: string
        name:
          description: Human-readable name for the Service Account.
          type: string
        roles:
          description: A list of Project roles associated with the Service Account.
          externalDocs:
            description: Project-level Roles for Service Accounts
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
        secrets:
          description: A list of secrets associated with the specified Service Account.
          items:
            "$ref": "#/components/schemas/ServiceAccountSecret"
          type: array
          uniqueItems: true
      type: object
    GroupServiceAccountRequest:
      properties:
        description:
          description: Human readable description for the Service Account.
          maxLength: 250
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        name:
          description: Human-readable name for the Service Account. The name is modifiable
            and does not have to be unique.
          maxLength: 64
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        roles:
          description: A list of project-level roles for the Service Account.
          externalDocs:
            description: Project-level Roles for Service Accounts
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          minItems: 1
          type: array
        secretExpiresAfterHours:
          description: The expiration time of the new Service Account secret, provided
            in hours. The minimum and maximum allowed expiration times are subject
            to change and are controlled by the organization's settings.
          example: 8
          format: int32
          type: integer
      required:
      - description
      - name
      - roles
      - secretExpiresAfterHours
      type: object
    GroupServiceAccountRoleAssignment:
      properties:
        roles:
          description: The Project permissions for the Service Account in the specified
            Project.
          externalDocs:
            description: Project-level Roles for Service Accounts
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
      required:
      - roles
      type: object
    GroupServiceAccountUpdateRequest:
      properties:
        description:
          description: Human readable description for the Service Account.
          maxLength: 250
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        name:
          description: Human-readable name for the Service Account. The name is modifiable
            and does not have to be unique.
          maxLength: 64
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        roles:
          description: A list of Project roles associated with the Service Account.
          externalDocs:
            description: Project-level Roles for Service Accounts
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
      type: object
    GroupSettings:
      description: Collection of settings that configures the project.
      properties:
        isClusterAiAssistantEnabled:
          description: Flag that indicates whether the AI Cluster Assistant is enabled
            for the specified project.
          type: boolean
        isCollectDatabaseSpecificsStatisticsEnabled:
          description: Flag that indicates whether to collect database-specific metrics
            for the specified project.
          type: boolean
        isDataExplorerEnabled:
          description: Flag that indicates whether to enable the Data Explorer for
            the specified project.
          type: boolean
        isDataExplorerGenAIFeaturesEnabled:
          description: Flag that indicates whether to enable the use of generative
            AI features which make requests to 3rd party services in Data Explorer
            for the specified project.
          type: boolean
        isDataExplorerGenAISampleDocumentPassingEnabled:
          default: false
          description: Flag that indicates whether to enable the passing of sample
            field values with the use of generative AI features in the Data Explorer
            for the specified project.
          type: boolean
        isExtendedStorageSizesEnabled:
          description: Flag that indicates whether to enable extended storage sizes
            for the specified project.
          type: boolean
        isNativeRerankingEnabled:
          description: Flag that indicates whether to enable Native Reranking with
            Voyage AI models in the Aggregation Pipeline for the specified project.
          type: boolean
        isPerformanceAdvisorEnabled:
          description: Flag that indicates whether to enable the Performance Advisor
            and Profiler for the specified project.
          type: boolean
        isRealtimePerformancePanelEnabled:
          description: Flag that indicates whether to enable the Real Time Performance
            Panel for the specified project.
          type: boolean
        isSchemaAdvisorEnabled:
          description: Flag that indicates whether to enable the Schema Advisor for
            the specified project.
          type: boolean
      type: object
    GroupUpdate:
      description: Request view to update the group.
      properties:
        name:
          description: Human-readable label that identifies the project included in
            the MongoDB Cloud organization.
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the project.
          externalDocs:
            description: Resource Tags
            url: https://www.mongodb.com/docs/atlas/tags
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        withDefaultAlertsSettings:
          description: Flag that indicates whether the project can automatically create
            default alerts.
          type: boolean
      type: object
    GroupUserRequest:
      properties:
        roles:
          description: One or more project-level roles to assign the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
          writeOnly: true
        username:
          description: Email address that represents the username of the MongoDB Cloud
            user.
          format: email
          type: string
          writeOnly: true
      required:
      - roles
      - username
      type: object
    GroupUserResponse:
      discriminator:
        mapping:
          ACTIVE: "#/components/schemas/GroupActiveUserResponse"
          PENDING: "#/components/schemas/GroupPendingUserResponse"
        propertyName: orgMembershipStatus
      oneOf:
      - "$ref": "#/components/schemas/GroupPendingUserResponse"
      - "$ref": "#/components/schemas/GroupActiveUserResponse"
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        orgMembershipStatus:
          description: String enum that indicates whether the MongoDB Cloud user has
            a pending invitation to join the organization or they are already active
            in the organization.
          enum:
          - PENDING
          - ACTIVE
          readOnly: true
          type: string
        roles:
          description: One or more project-level roles assigned to the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          readOnly: true
          type: array
          uniqueItems: true
        username:
          description: Email address that represents the username of the MongoDB Cloud
            user.
          format: email
          readOnly: true
          type: string
      required:
      - id
      - orgMembershipStatus
      - roles
      - username
      type: object
    HardwareSpec20240805:
      description: Hardware specifications for all electable nodes deployed in the
        region. Electable nodes can become the primary and can enable local reads.
        If you don't specify this option, MongoDB Cloud deploys no electable nodes
        to the region.
      oneOf:
      - "$ref": "#/components/schemas/AWSHardwareSpec20240805"
      - "$ref": "#/components/schemas/AzureHardwareSpec20240805"
      - "$ref": "#/components/schemas/GCPHardwareSpec20240805"
      - "$ref": "#/components/schemas/TenantHardwareSpec20240805"
      properties:
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value must be equal for
            all shards and node types.\n\n This value is not configurable on M0/M2/M5
            clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n
            If you specify a disk size below the minimum (10 GB), this parameter defaults
            to the minimum disk size value. \n\n Storage charge calculations depend
            on whether you choose the default value or a custom value.\n\n The maximum
            value for disk storage cannot exceed 50 times the maximum RAM for the
            selected cluster. If you require more storage space, consider upgrading
            your cluster to a higher tier."
          externalDocs:
            description: Customize Storage
            url: https://dochub.mongodb.org/core/customize-storage
          format: double
          type: number
      type: object
    Header:
      description: HTTP header with name and value.
      properties:
        name:
          description: Header name.
          example: Authorization
          type: string
        value:
          description: Header value.
          example: Bearer token123
          format: password
          type: string
      required:
      - name
      - value
      type: object
    HipChatNotification:
      description: HipChat notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notificationToken:
          description: |-
            HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `"notifications.[n].typeName" : "HIP_CHAT"`". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "************************************1234"
          type: string
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        roomName:
          description: 'HipChat API room name to which MongoDB Cloud sends alert notifications.
            The resource requires this parameter when `"notifications.[n].typeName"
            : "HIP_CHAT"`".'
          example: test room
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - HIP_CHAT
          type: string
      required:
      - typeName
      title: HipChat Notification
      type: object
    HostAlertConfigViewForNdsGroup:
      description: Host alert configuration allows to select which mongod host events
        trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/HostMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Host Alert Configuration
      type: object
    HostAlertViewForNdsGroup:
      description: Host alert notifies about activities on mongod host.
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: Host Alerts
      type: object
    HostEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - ATTEMPT_KILLOP_AUDIT
      - ATTEMPT_KILLSESSION_AUDIT
      - HOST_UP
      - HOST_DOWN
      - HOST_HAS_INDEX_SUGGESTIONS
      - HOST_MONGOT_RECOVERED_OOM
      - HOST_MONGOT_CRASHING_OOM
      - HOST_MONGOT_RESUME_REPLICATION
      - HOST_MONGOT_STOP_REPLICATION
      - HOST_MONGOT_UNPAUSE_INITIAL_SYNC
      - HOST_MONGOT_PAUSE_INITIAL_SYNC
      - HOST_MONGOT_SUFFICIENT_DISK_SPACE
      - HOST_MONGOT_APPROACHING_STOP_REPLICATION
      - HOST_MONGOT_RESTARTED
      - HOST_SEARCH_NODE_UNBLOCKED
      - HOST_SEARCH_NODE_INDEX_FAILED
      - HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN
      - HOST_EXTERNAL_LOG_SINK_EXPORT_RESUMED
      - HOST_ENOUGH_DISK_SPACE
      - HOST_NOT_ENOUGH_DISK_SPACE
      - SSH_KEY_NDS_HOST_ACCESS_REQUESTED
      - SSH_KEY_NDS_HOST_ACCESS_REFRESHED
      - SSH_KEY_NDS_HOST_ACCESS_ATTEMPT
      - SSH_KEY_NDS_HOST_ACCESS_GRANTED
      - SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED
      - ALERT_HOST_SSH_SESSION_STARTED
      - HOST_SSH_SESSION_ENDED
      - HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS
      - PUSH_BASED_LOG_EXPORT_RESUMED
      - PUSH_BASED_LOG_EXPORT_STOPPED
      - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
      - HOST_VERSION_BEHIND
      - VERSION_BEHIND
      - HOST_EXPOSED
      - HOST_SSL_CERTIFICATE_STALE
      - HOST_SECURITY_CHECKUP_NOT_MET
      - PROFILER_CONFIGURED_TOO_WIDELY
      example: HOST_DOWN
      title: Host Event Types
      type: string
    HostEventTypeViewForNdsGroupAlertable:
      description: Event type that triggers an alert.
      enum:
      - HOST_DOWN
      - HOST_HAS_INDEX_SUGGESTIONS
      - HOST_MONGOT_CRASHING_OOM
      - HOST_MONGOT_STOP_REPLICATION
      - HOST_MONGOT_APPROACHING_STOP_REPLICATION
      - HOST_MONGOT_PAUSE_INITIAL_SYNC
      - HOST_SEARCH_NODE_INDEX_FAILED
      - HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN
      - HOST_NOT_ENOUGH_DISK_SPACE
      - SSH_KEY_NDS_HOST_ACCESS_REQUESTED
      - SSH_KEY_NDS_HOST_ACCESS_REFRESHED
      - PUSH_BASED_LOG_EXPORT_STOPPED
      - PUSH_BASED_LOG_EXPORT_DROPPED_LOG
      - HOST_VERSION_BEHIND
      - VERSION_BEHIND
      - HOST_EXPOSED
      - HOST_SSL_CERTIFICATE_STALE
      - HOST_SECURITY_CHECKUP_NOT_MET
      - ALERT_HOST_SSH_SESSION_STARTED
      - PROFILER_CONFIGURED_TOO_WIDELY
      example: HOST_DOWN
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Host Event Types
      type: string
    HostEventViewForNdsGroup:
      description: Host event identifies different activities about mongod host.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        deskLocation:
          description: Desk location of MongoDB employee associated with the event.
          readOnly: true
          type: string
        employeeIdentifier:
          description: Identifier of MongoDB employee associated with the event.
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Host Events
      type: object
    HostMatcher:
      description: Rules to apply when comparing an host against this alert configuration.
      properties:
        fieldName:
          "$ref": "#/components/schemas/HostMatcherField"
        operator:
          description: Comparison operator to apply when checking the current metric
            value against **matcher[n].value**. The `REGEX` operator only supports
            inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
          type: string
        value:
          "$ref": "#/components/schemas/MatcherHostType"
      required:
      - fieldName
      - operator
      title: Matchers
      type: object
    HostMatcherField:
      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:
      - TYPE_NAME
      - HOSTNAME
      - PORT
      - HOSTNAME_AND_PORT
      - REPLICA_SET_NAME
      - ATLAS_NODE_TYPE
      example: HOSTNAME
      title: Host Matcher Fields
      type: string
    HostMetricAlert:
      description: Host Metric Alert notifies about changes of measurements or metrics
        for mongod host.
      discriminator:
        mapping:
          ASSERT_MSG: "#/components/schemas/RawMetricAlertView"
          ASSERT_REGULAR: "#/components/schemas/RawMetricAlertView"
          ASSERT_USER: "#/components/schemas/RawMetricAlertView"
          ASSERT_WARNING: "#/components/schemas/RawMetricAlertView"
          AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/TimeMetricAlertView"
          AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricAlertView"
          AVG_WRITE_EXECUTION_TIME: "#/components/schemas/TimeMetricAlertView"
          BACKGROUND_FLUSH_AVG: "#/components/schemas/TimeMetricAlertView"
          CACHE_BYTES_READ_INTO: "#/components/schemas/DataMetricAlertView"
          CACHE_BYTES_WRITTEN_FROM: "#/components/schemas/DataMetricAlertView"
          CACHE_USAGE_DIRTY: "#/components/schemas/DataMetricAlertView"
          CACHE_USAGE_USED: "#/components/schemas/DataMetricAlertView"
          COMPUTED_MEMORY: "#/components/schemas/DataMetricAlertView"
          CONNECTIONS: "#/components/schemas/RawMetricAlertView"
          CONNECTIONS_MAX: "#/components/schemas/RawMetricAlertView"
          CONNECTIONS_PERCENT: "#/components/schemas/RawMetricAlertView"
          CURSORS_TOTAL_CLIENT_CURSORS_SIZE: "#/components/schemas/RawMetricAlertView"
          CURSORS_TOTAL_OPEN: "#/components/schemas/RawMetricAlertView"
          CURSORS_TOTAL_TIMED_OUT: "#/components/schemas/RawMetricAlertView"
          DB_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricAlertView"
          DB_DATA_SIZE_TOTAL_WO_SYSTEM: "#/components/schemas/DataMetricAlertView"
          DB_INDEX_SIZE_TOTAL: "#/components/schemas/DataMetricAlertView"
          DB_STORAGE_TOTAL: "#/components/schemas/DataMetricAlertView"
          DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_READ_IOPS_DATA: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_READ_LATENCY_DATA: "#/components/schemas/TimeMetricAlertView"
          DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/TimeMetricAlertView"
          DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/TimeMetricAlertView"
          DISK_PARTITION_SPACE_USED_DATA: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_SPACE_USED_INDEX: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_SPACE_USED_JOURNAL: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_UTILIZATION_DATA: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_UTILIZATION_INDEX: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_UTILIZATION_JOURNAL: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_WRITE_IOPS_DATA: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_WRITE_IOPS_INDEX: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_WRITE_IOPS_JOURNAL: "#/components/schemas/RawMetricAlertView"
          DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/TimeMetricAlertView"
          DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/TimeMetricAlertView"
          DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/TimeMetricAlertView"
          DOCUMENT_DELETED: "#/components/schemas/RawMetricAlertView"
          DOCUMENT_INSERTED: "#/components/schemas/RawMetricAlertView"
          DOCUMENT_RETURNED: "#/components/schemas/RawMetricAlertView"
          DOCUMENT_UPDATED: "#/components/schemas/RawMetricAlertView"
          EXTRA_INFO_PAGE_FAULTS: "#/components/schemas/RawMetricAlertView"
          FTS_DISK_UTILIZATION: "#/components/schemas/DataMetricAlertView"
          FTS_JVM_CURRENT_MEMORY: "#/components/schemas/DataMetricAlertView"
          FTS_JVM_MAX_MEMORY: "#/components/schemas/DataMetricAlertView"
          FTS_MEMORY_MAPPED: "#/components/schemas/DataMetricAlertView"
          FTS_MEMORY_RESIDENT: "#/components/schemas/DataMetricAlertView"
          FTS_MEMORY_VIRTUAL: "#/components/schemas/DataMetricAlertView"
          FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricAlertView"
          FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricAlertView"
          GLOBAL_ACCESSES_NOT_IN_MEMORY: "#/components/schemas/RawMetricAlertView"
          GLOBAL_LOCK_CURRENT_QUEUE_READERS: "#/components/schemas/RawMetricAlertView"
          GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: "#/components/schemas/RawMetricAlertView"
          GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: "#/components/schemas/RawMetricAlertView"
          GLOBAL_LOCK_PERCENTAGE: "#/components/schemas/RawMetricAlertView"
          GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: "#/components/schemas/RawMetricAlertView"
          INDEX_COUNTERS_BTREE_ACCESSES: "#/components/schemas/RawMetricAlertView"
          INDEX_COUNTERS_BTREE_HITS: "#/components/schemas/RawMetricAlertView"
          INDEX_COUNTERS_BTREE_MISSES: "#/components/schemas/RawMetricAlertView"
          INDEX_COUNTERS_BTREE_MISS_RATIO: "#/components/schemas/RawMetricAlertView"
          JOURNALING_COMMITS_IN_WRITE_LOCK: "#/components/schemas/RawMetricAlertView"
          JOURNALING_MB: "#/components/schemas/DataMetricAlertView"
          JOURNALING_WRITE_DATA_FILES_MB: "#/components/schemas/DataMetricAlertView"
          LOGICAL_SIZE: "#/components/schemas/DataMetricAlertView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_READ_IOPS_DATA: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_READ_LATENCY_DATA: "#/components/schemas/TimeMetricAlertView"
          MAX_DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/TimeMetricAlertView"
          MAX_DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/TimeMetricAlertView"
          MAX_DISK_PARTITION_SPACE_USED_DATA: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_SPACE_USED_INDEX: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_SPACE_USED_JOURNAL: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_UTILIZATION_DATA: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_UTILIZATION_INDEX: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_UTILIZATION_JOURNAL: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_WRITE_IOPS_DATA: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_WRITE_IOPS_INDEX: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL: "#/components/schemas/RawMetricAlertView"
          MAX_DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/TimeMetricAlertView"
          MAX_DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/TimeMetricAlertView"
          MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/TimeMetricAlertView"
          MAX_NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricAlertView"
          MAX_NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricAlertView"
          MAX_SWAP_USAGE_FREE: "#/components/schemas/DataMetricAlertView"
          MAX_SWAP_USAGE_USED: "#/components/schemas/DataMetricAlertView"
          MAX_SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricAlertView"
          MAX_SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricAlertView"
          MAX_SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricAlertView"
          MAX_SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricAlertView"
          MAX_SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricAlertView"
          MEMORY_MAPPED: "#/components/schemas/DataMetricAlertView"
          MEMORY_RESIDENT: "#/components/schemas/DataMetricAlertView"
          MEMORY_VIRTUAL: "#/components/schemas/DataMetricAlertView"
          MUNIN_CPU_IOWAIT: "#/components/schemas/RawMetricAlertView"
          MUNIN_CPU_IRQ: "#/components/schemas/RawMetricAlertView"
          MUNIN_CPU_NICE: "#/components/schemas/RawMetricAlertView"
          MUNIN_CPU_SOFTIRQ: "#/components/schemas/RawMetricAlertView"
          MUNIN_CPU_STEAL: "#/components/schemas/RawMetricAlertView"
          MUNIN_CPU_SYSTEM: "#/components/schemas/RawMetricAlertView"
          MUNIN_CPU_USER: "#/components/schemas/RawMetricAlertView"
          NETWORK_BYTES_IN: "#/components/schemas/DataMetricAlertView"
          NETWORK_BYTES_OUT: "#/components/schemas/DataMetricAlertView"
          NETWORK_NUM_REQUESTS: "#/components/schemas/RawMetricAlertView"
          NORMALIZED_FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricAlertView"
          NORMALIZED_FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricAlertView"
          NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricAlertView"
          NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_CMD: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_DELETE: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_GETMORE: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_INSERT: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_QUERY: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_REPL_CMD: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_REPL_DELETE: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_TTL_DELETED: "#/components/schemas/RawMetricAlertView"
          OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView"
          OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView"
          OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView"
          OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView"
          OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView"
          OPLOG_MASTER_TIME: "#/components/schemas/TimeMetricAlertView"
          OPLOG_MASTER_TIME_ESTIMATED_TTL: "#/components/schemas/TimeMetricAlertView"
          OPLOG_RATE_GB_PER_HOUR: "#/components/schemas/DataMetricAlertView"
          OPLOG_REPLICATION_LAG_TIME: "#/components/schemas/TimeMetricAlertView"
          OPLOG_SLAVE_LAG_MASTER_TIME: "#/components/schemas/TimeMetricAlertView"
          QUERY_EXECUTOR_SCANNED: "#/components/schemas/RawMetricAlertView"
          QUERY_EXECUTOR_SCANNED_OBJECTS: "#/components/schemas/RawMetricAlertView"
          QUERY_SPILL_TO_DISK_DURING_SORT: "#/components/schemas/RawMetricAlertView"
          QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: "#/components/schemas/RawMetricAlertView"
          QUERY_TARGETING_SCANNED_PER_RETURNED: "#/components/schemas/RawMetricAlertView"
          RESTARTS_IN_LAST_HOUR: "#/components/schemas/RawMetricAlertView"
          SEARCH_INDEX_SIZE: "#/components/schemas/DataMetricAlertView"
          SEARCH_MAX_FIELDS_INDEXED: "#/components/schemas/RawMetricAlertView"
          SEARCH_MAX_NGRAM_FIELDS_INDEXED: "#/components/schemas/RawMetricAlertView"
          SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: "#/components/schemas/NumberMetricAlertView"
          SEARCH_NUMBER_OF_FIELDS_IN_INDEX: "#/components/schemas/RawMetricAlertView"
          SEARCH_NUMBER_OF_QUERIES_ERROR: "#/components/schemas/RawMetricAlertView"
          SEARCH_NUMBER_OF_QUERIES_SUCCESS: "#/components/schemas/RawMetricAlertView"
          SEARCH_NUMBER_OF_QUERIES_TOTAL: "#/components/schemas/RawMetricAlertView"
          SEARCH_OPCOUNTER_DELETE: "#/components/schemas/RawMetricAlertView"
          SEARCH_OPCOUNTER_GETMORE: "#/components/schemas/RawMetricAlertView"
          SEARCH_OPCOUNTER_INSERT: "#/components/schemas/RawMetricAlertView"
          SEARCH_OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView"
          SEARCH_PROCESS_THROTTLING: "#/components/schemas/RawMetricAlertView"
          SEARCH_REPLICATION_LAG: "#/components/schemas/TimeMetricAlertView"
          SWAP_USAGE_FREE: "#/components/schemas/DataMetricAlertView"
          SWAP_USAGE_USED: "#/components/schemas/DataMetricAlertView"
          SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricAlertView"
          SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricAlertView"
          SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricAlertView"
          SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricAlertView"
          SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricAlertView"
          TICKETS_AVAILABLE_READS: "#/components/schemas/RawMetricAlertView"
          TICKETS_AVAILABLE_WRITES: "#/components/schemas/RawMetricAlertView"
        propertyName: metricName
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/HostMetricValue"
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: |-
            Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.

            To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.

            **NOTE**: If you set `eventTypeName` to `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
          example: ASSERT_USER
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: Host Metric Alerts
      type: object
    HostMetricAlertConfigViewForNdsGroup:
      description: Host metric alert configuration allows to select which mongod host
        metrics trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/HostMatcher"
          type: array
        metricThreshold:
          "$ref": "#/components/schemas/HostMetricThreshold"
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Host Metric Alert Configuration
      type: object
    HostMetricEvent:
      description: Host Metric Event reflects different measurements and metrics about
        mongod host.
      discriminator:
        mapping:
          ASSERT_MSG: "#/components/schemas/RawMetricEventView"
          ASSERT_REGULAR: "#/components/schemas/RawMetricEventView"
          ASSERT_USER: "#/components/schemas/RawMetricEventView"
          ASSERT_WARNING: "#/components/schemas/RawMetricEventView"
          AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/TimeMetricEventView"
          AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricEventView"
          AVG_WRITE_EXECUTION_TIME: "#/components/schemas/TimeMetricEventView"
          BACKGROUND_FLUSH_AVG: "#/components/schemas/TimeMetricEventView"
          CACHE_BYTES_READ_INTO: "#/components/schemas/DataMetricEventView"
          CACHE_BYTES_WRITTEN_FROM: "#/components/schemas/DataMetricEventView"
          CACHE_USAGE_DIRTY: "#/components/schemas/DataMetricEventView"
          CACHE_USAGE_USED: "#/components/schemas/DataMetricEventView"
          COMPUTED_MEMORY: "#/components/schemas/DataMetricEventView"
          CONNECTIONS: "#/components/schemas/RawMetricEventView"
          CONNECTIONS_MAX: "#/components/schemas/RawMetricEventView"
          CONNECTIONS_PERCENT: "#/components/schemas/RawMetricEventView"
          CURSORS_TOTAL_CLIENT_CURSORS_SIZE: "#/components/schemas/RawMetricEventView"
          CURSORS_TOTAL_OPEN: "#/components/schemas/RawMetricEventView"
          CURSORS_TOTAL_TIMED_OUT: "#/components/schemas/RawMetricEventView"
          DB_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricEventView"
          DB_DATA_SIZE_TOTAL_WO_SYSTEM: "#/components/schemas/DataMetricEventView"
          DB_INDEX_SIZE_TOTAL: "#/components/schemas/DataMetricEventView"
          DB_STORAGE_TOTAL: "#/components/schemas/DataMetricEventView"
          DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_READ_IOPS_DATA: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_READ_LATENCY_DATA: "#/components/schemas/TimeMetricEventView"
          DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/TimeMetricEventView"
          DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/TimeMetricEventView"
          DISK_PARTITION_SPACE_USED_DATA: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_SPACE_USED_INDEX: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_SPACE_USED_JOURNAL: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_UTILIZATION_DATA: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_UTILIZATION_INDEX: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_UTILIZATION_JOURNAL: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_WRITE_IOPS_DATA: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_WRITE_IOPS_INDEX: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_WRITE_IOPS_JOURNAL: "#/components/schemas/RawMetricEventView"
          DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/TimeMetricEventView"
          DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/TimeMetricEventView"
          DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/TimeMetricEventView"
          DOCUMENT_DELETED: "#/components/schemas/RawMetricEventView"
          DOCUMENT_INSERTED: "#/components/schemas/RawMetricEventView"
          DOCUMENT_RETURNED: "#/components/schemas/RawMetricEventView"
          DOCUMENT_UPDATED: "#/components/schemas/RawMetricEventView"
          EXTRA_INFO_PAGE_FAULTS: "#/components/schemas/RawMetricEventView"
          FTS_DISK_UTILIZATION: "#/components/schemas/DataMetricEventView"
          FTS_JVM_CURRENT_MEMORY: "#/components/schemas/DataMetricEventView"
          FTS_JVM_MAX_MEMORY: "#/components/schemas/DataMetricEventView"
          FTS_MEMORY_MAPPED: "#/components/schemas/DataMetricEventView"
          FTS_MEMORY_RESIDENT: "#/components/schemas/DataMetricEventView"
          FTS_MEMORY_VIRTUAL: "#/components/schemas/DataMetricEventView"
          FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricEventView"
          FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricEventView"
          GLOBAL_ACCESSES_NOT_IN_MEMORY: "#/components/schemas/RawMetricEventView"
          GLOBAL_LOCK_CURRENT_QUEUE_READERS: "#/components/schemas/RawMetricEventView"
          GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: "#/components/schemas/RawMetricEventView"
          GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: "#/components/schemas/RawMetricEventView"
          GLOBAL_LOCK_PERCENTAGE: "#/components/schemas/RawMetricEventView"
          GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: "#/components/schemas/RawMetricEventView"
          INDEX_COUNTERS_BTREE_ACCESSES: "#/components/schemas/RawMetricEventView"
          INDEX_COUNTERS_BTREE_HITS: "#/components/schemas/RawMetricEventView"
          INDEX_COUNTERS_BTREE_MISSES: "#/components/schemas/RawMetricEventView"
          INDEX_COUNTERS_BTREE_MISS_RATIO: "#/components/schemas/RawMetricEventView"
          JOURNALING_COMMITS_IN_WRITE_LOCK: "#/components/schemas/RawMetricEventView"
          JOURNALING_MB: "#/components/schemas/DataMetricEventView"
          JOURNALING_WRITE_DATA_FILES_MB: "#/components/schemas/DataMetricEventView"
          LOGICAL_SIZE: "#/components/schemas/DataMetricEventView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_READ_IOPS_DATA: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_READ_LATENCY_DATA: "#/components/schemas/TimeMetricEventView"
          MAX_DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/TimeMetricEventView"
          MAX_DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/TimeMetricEventView"
          MAX_DISK_PARTITION_SPACE_USED_DATA: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_SPACE_USED_INDEX: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_SPACE_USED_JOURNAL: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_UTILIZATION_DATA: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_UTILIZATION_INDEX: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_UTILIZATION_JOURNAL: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_WRITE_IOPS_DATA: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_WRITE_IOPS_INDEX: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL: "#/components/schemas/RawMetricEventView"
          MAX_DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/TimeMetricEventView"
          MAX_DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/TimeMetricEventView"
          MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/TimeMetricEventView"
          MAX_NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricEventView"
          MAX_NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricEventView"
          MAX_SWAP_USAGE_FREE: "#/components/schemas/DataMetricEventView"
          MAX_SWAP_USAGE_USED: "#/components/schemas/DataMetricEventView"
          MAX_SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricEventView"
          MAX_SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricEventView"
          MAX_SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricEventView"
          MAX_SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricEventView"
          MAX_SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricEventView"
          MEMORY_MAPPED: "#/components/schemas/DataMetricEventView"
          MEMORY_RESIDENT: "#/components/schemas/DataMetricEventView"
          MEMORY_VIRTUAL: "#/components/schemas/DataMetricEventView"
          MUNIN_CPU_IOWAIT: "#/components/schemas/RawMetricEventView"
          MUNIN_CPU_IRQ: "#/components/schemas/RawMetricEventView"
          MUNIN_CPU_NICE: "#/components/schemas/RawMetricEventView"
          MUNIN_CPU_SOFTIRQ: "#/components/schemas/RawMetricEventView"
          MUNIN_CPU_STEAL: "#/components/schemas/RawMetricEventView"
          MUNIN_CPU_SYSTEM: "#/components/schemas/RawMetricEventView"
          MUNIN_CPU_USER: "#/components/schemas/RawMetricEventView"
          NETWORK_BYTES_IN: "#/components/schemas/DataMetricEventView"
          NETWORK_BYTES_OUT: "#/components/schemas/DataMetricEventView"
          NETWORK_NUM_REQUESTS: "#/components/schemas/RawMetricEventView"
          NORMALIZED_FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricEventView"
          NORMALIZED_FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricEventView"
          NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricEventView"
          NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_CMD: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_DELETE: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_GETMORE: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_INSERT: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_QUERY: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_REPL_CMD: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_REPL_DELETE: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_TTL_DELETED: "#/components/schemas/RawMetricEventView"
          OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView"
          OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView"
          OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView"
          OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView"
          OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView"
          OPLOG_MASTER_TIME: "#/components/schemas/TimeMetricEventView"
          OPLOG_MASTER_TIME_ESTIMATED_TTL: "#/components/schemas/TimeMetricEventView"
          OPLOG_RATE_GB_PER_HOUR: "#/components/schemas/DataMetricEventView"
          OPLOG_REPLICATION_LAG_TIME: "#/components/schemas/TimeMetricEventView"
          OPLOG_SLAVE_LAG_MASTER_TIME: "#/components/schemas/TimeMetricEventView"
          QUERY_EXECUTOR_SCANNED: "#/components/schemas/RawMetricEventView"
          QUERY_EXECUTOR_SCANNED_OBJECTS: "#/components/schemas/RawMetricEventView"
          QUERY_SPILL_TO_DISK_DURING_SORT: "#/components/schemas/RawMetricEventView"
          QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: "#/components/schemas/RawMetricEventView"
          QUERY_TARGETING_SCANNED_PER_RETURNED: "#/components/schemas/RawMetricEventView"
          RESTARTS_IN_LAST_HOUR: "#/components/schemas/RawMetricEventView"
          SEARCH_INDEX_SIZE: "#/components/schemas/DataMetricEventView"
          SEARCH_MAX_FIELDS_INDEXED: "#/components/schemas/RawMetricEventView"
          SEARCH_MAX_NGRAM_FIELDS_INDEXED: "#/components/schemas/RawMetricEventView"
          SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: "#/components/schemas/NumberMetricEventView"
          SEARCH_NUMBER_OF_FIELDS_IN_INDEX: "#/components/schemas/RawMetricEventView"
          SEARCH_NUMBER_OF_QUERIES_ERROR: "#/components/schemas/RawMetricEventView"
          SEARCH_NUMBER_OF_QUERIES_SUCCESS: "#/components/schemas/RawMetricEventView"
          SEARCH_NUMBER_OF_QUERIES_TOTAL: "#/components/schemas/RawMetricEventView"
          SEARCH_OPCOUNTER_DELETE: "#/components/schemas/RawMetricEventView"
          SEARCH_OPCOUNTER_GETMORE: "#/components/schemas/RawMetricEventView"
          SEARCH_OPCOUNTER_INSERT: "#/components/schemas/RawMetricEventView"
          SEARCH_OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView"
          SEARCH_PROCESS_THROTTLING: "#/components/schemas/RawMetricEventView"
          SEARCH_REPLICATION_LAG: "#/components/schemas/TimeMetricEventView"
          SWAP_USAGE_FREE: "#/components/schemas/DataMetricEventView"
          SWAP_USAGE_USED: "#/components/schemas/DataMetricEventView"
          SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricEventView"
          SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricEventView"
          SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricEventView"
          SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricEventView"
          SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricEventView"
          TICKETS_AVAILABLE_READS: "#/components/schemas/RawMetricEventView"
          TICKETS_AVAILABLE_WRITES: "#/components/schemas/RawMetricEventView"
        propertyName: metricName
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/HostMetricValue"
        deskLocation:
          description: Desk location of MongoDB employee associated with the event.
          readOnly: true
          type: string
        employeeIdentifier:
          description: Identifier of MongoDB employee associated with the event.
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: Human-readable label of the metric associated with the `alertId`.
            This field may change type of `currentValue` field.
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Host Metric Events
      type: object
    HostMetricEventTypeView:
      description: Unique identifier of event type.
      enum:
      - INSIDE_METRIC_THRESHOLD
      - OUTSIDE_METRIC_THRESHOLD
      example: OUTSIDE_METRIC_THRESHOLD
      title: Host Metric Event Types
      type: string
    HostMetricEventTypeViewAlertable:
      description: Event type that triggers an alert.
      enum:
      - OUTSIDE_METRIC_THRESHOLD
      example: OUTSIDE_METRIC_THRESHOLD
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Host Metric Event Types
      type: string
    HostMetricThreshold:
      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 about mongod host.
      discriminator:
        mapping:
          ASSERT_MSG: "#/components/schemas/AssertMsgRawMetricThresholdView"
          ASSERT_REGULAR: "#/components/schemas/AssertRegularRawMetricThresholdView"
          ASSERT_USER: "#/components/schemas/AssertUserRawMetricThresholdView"
          ASSERT_WARNING: "#/components/schemas/AssertWarningRawMetricThresholdView"
          AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/AvgCommandExecutionTimeTimeMetricThresholdView"
          AVG_READ_EXECUTION_TIME: "#/components/schemas/AvgReadExecutionTimeTimeMetricThresholdView"
          AVG_WRITE_EXECUTION_TIME: "#/components/schemas/AvgWriteExecutionTimeTimeMetricThresholdView"
          BACKGROUND_FLUSH_AVG: "#/components/schemas/TimeMetricThresholdView"
          CACHE_BYTES_READ_INTO: "#/components/schemas/CacheBytesReadIntoDataMetricThresholdView"
          CACHE_BYTES_WRITTEN_FROM: "#/components/schemas/CacheBytesWrittenFromDataMetricThresholdView"
          CACHE_USAGE_DIRTY: "#/components/schemas/CacheUsageDirtyDataMetricThresholdView"
          CACHE_USAGE_USED: "#/components/schemas/CacheUsageUsedDataMetricThresholdView"
          COMPUTED_MEMORY: "#/components/schemas/ComputedMemoryDataMetricThresholdView"
          CONNECTIONS: "#/components/schemas/ConnectionsRawMetricThresholdView"
          CONNECTIONS_MAX: "#/components/schemas/ConnectionsMaxRawMetricThresholdView"
          CONNECTIONS_PERCENT: "#/components/schemas/ConnectionsPercentRawMetricThresholdView"
          CURSORS_TOTAL_CLIENT_CURSORS_SIZE: "#/components/schemas/CursorsTotalClientCursorsSizeRawMetricThresholdView"
          CURSORS_TOTAL_OPEN: "#/components/schemas/CursorsTotalOpenRawMetricThresholdView"
          CURSORS_TOTAL_TIMED_OUT: "#/components/schemas/CursorsTotalTimedOutRawMetricThresholdView"
          DB_DATA_SIZE_TOTAL: "#/components/schemas/DbDataSizeTotalDataMetricThresholdView"
          DB_DATA_SIZE_TOTAL_WO_SYSTEM: "#/components/schemas/DbDataSizeTotalWoSystemDataMetricThresholdView"
          DB_INDEX_SIZE_TOTAL: "#/components/schemas/DbIndexSizeTotalDataMetricThresholdView"
          DB_STORAGE_TOTAL: "#/components/schemas/DbStorageTotalDataMetricThresholdView"
          DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/DiskPartitionQueueDepthDataRawMetricThresholdView"
          DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/DiskPartitionQueueDepthIndexRawMetricThresholdView"
          DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/DiskPartitionQueueDepthJournalRawMetricThresholdView"
          DISK_PARTITION_READ_IOPS_DATA: "#/components/schemas/DiskPartitionReadIopsDataRawMetricThresholdView"
          DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/DiskPartitionReadIopsIndexRawMetricThresholdView"
          DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/DiskPartitionReadIopsJournalRawMetricThresholdView"
          DISK_PARTITION_READ_LATENCY_DATA: "#/components/schemas/DiskPartitionReadLatencyDataTimeMetricThresholdView"
          DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/DiskPartitionReadLatencyIndexTimeMetricThresholdView"
          DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/DiskPartitionReadLatencyJournalTimeMetricThresholdView"
          DISK_PARTITION_SPACE_USED_DATA: "#/components/schemas/DiskPartitionSpaceUsedDataRawMetricThresholdView"
          DISK_PARTITION_SPACE_USED_INDEX: "#/components/schemas/DiskPartitionSpaceUsedIndexRawMetricThresholdView"
          DISK_PARTITION_SPACE_USED_JOURNAL: "#/components/schemas/DiskPartitionSpaceUsedJournalRawMetricThresholdView"
          DISK_PARTITION_WRITE_IOPS_DATA: "#/components/schemas/DiskPartitionWriteIopsDataRawMetricThresholdView"
          DISK_PARTITION_WRITE_IOPS_INDEX: "#/components/schemas/DiskPartitionWriteIopsIndexRawMetricThresholdView"
          DISK_PARTITION_WRITE_IOPS_JOURNAL: "#/components/schemas/DiskPartitionWriteIopsJournalRawMetricThresholdView"
          DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/DiskPartitionWriteLatencyDataTimeMetricThresholdView"
          DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/DiskPartitionWriteLatencyIndexTimeMetricThresholdView"
          DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/DiskPartitionWriteLatencyJournalTimeMetricThresholdView"
          DOCUMENT_DELETED: "#/components/schemas/DocumentDeletedRawMetricThresholdView"
          DOCUMENT_INSERTED: "#/components/schemas/DocumentInsertedRawMetricThresholdView"
          DOCUMENT_RETURNED: "#/components/schemas/DocumentReturnedRawMetricThresholdView"
          DOCUMENT_UPDATED: "#/components/schemas/DocumentUpdatedRawMetricThresholdView"
          EXTRA_INFO_PAGE_FAULTS: "#/components/schemas/ExtraInfoPageFaultsRawMetricThresholdView"
          FTS_DISK_UTILIZATION: "#/components/schemas/FtsDiskUtilizationDataMetricThresholdView"
          FTS_JVM_CURRENT_MEMORY: "#/components/schemas/FtsJvmCurrentMemoryDataMetricThresholdView"
          FTS_JVM_MAX_MEMORY: "#/components/schemas/FtsJvmMaxMemoryDataMetricThresholdView"
          FTS_MEMORY_MAPPED: "#/components/schemas/FtsMemoryMappedDataMetricThresholdView"
          FTS_MEMORY_RESIDENT: "#/components/schemas/FtsMemoryResidentDataMetricThresholdView"
          FTS_MEMORY_VIRTUAL: "#/components/schemas/FtsMemoryVirtualDataMetricThresholdView"
          FTS_PROCESS_CPU_KERNEL: "#/components/schemas/FtsProcessCpuKernelRawMetricThresholdView"
          FTS_PROCESS_CPU_USER: "#/components/schemas/FtsProcessCpuUserRawMetricThresholdView"
          GLOBAL_ACCESSES_NOT_IN_MEMORY: "#/components/schemas/GlobalAccessesNotInMemoryRawMetricThresholdView"
          GLOBAL_LOCK_CURRENT_QUEUE_READERS: "#/components/schemas/GlobalLockCurrentQueueReadersRawMetricThresholdView"
          GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: "#/components/schemas/GlobalLockCurrentQueueTotalRawMetricThresholdView"
          GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: "#/components/schemas/GlobalLockCurrentQueueWritersRawMetricThresholdView"
          GLOBAL_LOCK_PERCENTAGE: "#/components/schemas/GlobalLockPercentageRawMetricThresholdView"
          GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: "#/components/schemas/GlobalPageFaultExceptionsThrownRawMetricThresholdView"
          INDEX_COUNTERS_BTREE_ACCESSES: "#/components/schemas/IndexCountersBtreeAccessesRawMetricThresholdView"
          INDEX_COUNTERS_BTREE_HITS: "#/components/schemas/IndexCountersBtreeHitsRawMetricThresholdView"
          INDEX_COUNTERS_BTREE_MISSES: "#/components/schemas/IndexCountersBtreeMissesRawMetricThresholdView"
          INDEX_COUNTERS_BTREE_MISS_RATIO: "#/components/schemas/IndexCountersBtreeMissRatioRawMetricThresholdView"
          JOURNALING_COMMITS_IN_WRITE_LOCK: "#/components/schemas/JournalingCommitsInWriteLockRawMetricThresholdView"
          JOURNALING_MB: "#/components/schemas/JournalingMbDataMetricThresholdView"
          JOURNALING_WRITE_DATA_FILES_MB: "#/components/schemas/JournalingWriteDataFilesMbDataMetricThresholdView"
          LOGICAL_SIZE: "#/components/schemas/LogicalSizeDataMetricThresholdView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/MaxDiskPartitionQueueDepthDataRawMetricThresholdView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/MaxDiskPartitionQueueDepthIndexRawMetricThresholdView"
          MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/MaxDiskPartitionQueueDepthJournalRawMetricThresholdView"
          MAX_DISK_PARTITION_READ_IOPS_DATA: "#/components/schemas/MaxDiskPartitionReadIopsDataRawMetricThresholdView"
          MAX_DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/MaxDiskPartitionReadIopsIndexRawMetricThresholdView"
          MAX_DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/MaxDiskPartitionReadIopsJournalRawMetricThresholdView"
          MAX_DISK_PARTITION_READ_LATENCY_DATA: "#/components/schemas/MaxDiskPartitionReadLatencyDataTimeMetricThresholdView"
          MAX_DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView"
          MAX_DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView"
          MAX_DISK_PARTITION_SPACE_USED_DATA: "#/components/schemas/MaxDiskPartitionSpaceUsedDataRawMetricThresholdView"
          MAX_DISK_PARTITION_SPACE_USED_INDEX: "#/components/schemas/MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView"
          MAX_DISK_PARTITION_SPACE_USED_JOURNAL: "#/components/schemas/MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView"
          MAX_DISK_PARTITION_WRITE_IOPS_DATA: "#/components/schemas/MaxDiskPartitionWriteIopsDataRawMetricThresholdView"
          MAX_DISK_PARTITION_WRITE_IOPS_INDEX: "#/components/schemas/MaxDiskPartitionWriteIopsIndexRawMetricThresholdView"
          MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL: "#/components/schemas/MaxDiskPartitionWriteIopsJournalRawMetricThresholdView"
          MAX_DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView"
          MAX_DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView"
          MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView"
          MAX_NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/MaxNormalizedSystemCpuStealRawMetricThresholdView"
          MAX_NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/MaxNormalizedSystemCpuUserRawMetricThresholdView"
          MAX_SWAP_USAGE_FREE: "#/components/schemas/MaxSwapUsageFreeDataMetricThresholdView"
          MAX_SWAP_USAGE_USED: "#/components/schemas/MaxSwapUsageUsedDataMetricThresholdView"
          MAX_SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/MaxSystemMemoryAvailableDataMetricThresholdView"
          MAX_SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/MaxSystemMemoryPercentUsedRawMetricThresholdView"
          MAX_SYSTEM_MEMORY_USED: "#/components/schemas/MaxSystemMemoryUsedDataMetricThresholdView"
          MAX_SYSTEM_NETWORK_IN: "#/components/schemas/MaxSystemNetworkInDataMetricThresholdView"
          MAX_SYSTEM_NETWORK_OUT: "#/components/schemas/MaxSystemNetworkOutDataMetricThresholdView"
          MEMORY_MAPPED: "#/components/schemas/MemoryMappedDataMetricThresholdView"
          MEMORY_RESIDENT: "#/components/schemas/MemoryResidentDataMetricThresholdView"
          MEMORY_VIRTUAL: "#/components/schemas/MemoryVirtualDataMetricThresholdView"
          MUNIN_CPU_IOWAIT: "#/components/schemas/MuninCpuIowaitRawMetricThresholdView"
          MUNIN_CPU_IRQ: "#/components/schemas/MuninCpuIrqRawMetricThresholdView"
          MUNIN_CPU_NICE: "#/components/schemas/MuninCpuNiceRawMetricThresholdView"
          MUNIN_CPU_SOFTIRQ: "#/components/schemas/MuninCpuSoftirqRawMetricThresholdView"
          MUNIN_CPU_STEAL: "#/components/schemas/MuninCpuStealRawMetricThresholdView"
          MUNIN_CPU_SYSTEM: "#/components/schemas/MuninCpuSystemRawMetricThresholdView"
          MUNIN_CPU_USER: "#/components/schemas/MuninCpuUserRawMetricThresholdView"
          NETWORK_BYTES_IN: "#/components/schemas/NetworkBytesInDataMetricThresholdView"
          NETWORK_BYTES_OUT: "#/components/schemas/NetworkBytesOutDataMetricThresholdView"
          NETWORK_NUM_REQUESTS: "#/components/schemas/NetworkNumRequestsRawMetricThresholdView"
          NORMALIZED_FTS_PROCESS_CPU_KERNEL: "#/components/schemas/NormalizedFtsProcessCpuKernelRawMetricThresholdView"
          NORMALIZED_FTS_PROCESS_CPU_USER: "#/components/schemas/NormalizedFtsProcessCpuUserRawMetricThresholdView"
          NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/NormalizedSystemCpuStealRawMetricThresholdView"
          NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/NormalizedSystemCpuUserRawMetricThresholdView"
          OPCOUNTER_CMD: "#/components/schemas/OpCounterCmdRawMetricThresholdView"
          OPCOUNTER_DELETE: "#/components/schemas/OpCounterDeleteRawMetricThresholdView"
          OPCOUNTER_GETMORE: "#/components/schemas/OpCounterGetMoreRawMetricThresholdView"
          OPCOUNTER_INSERT: "#/components/schemas/OpCounterInsertRawMetricThresholdView"
          OPCOUNTER_QUERY: "#/components/schemas/OpCounterQueryRawMetricThresholdView"
          OPCOUNTER_REPL_CMD: "#/components/schemas/OpCounterReplCmdRawMetricThresholdView"
          OPCOUNTER_REPL_DELETE: "#/components/schemas/OpCounterReplDeleteRawMetricThresholdView"
          OPCOUNTER_REPL_INSERT: "#/components/schemas/OpCounterReplInsertRawMetricThresholdView"
          OPCOUNTER_REPL_UPDATE: "#/components/schemas/OpCounterReplUpdateRawMetricThresholdView"
          OPCOUNTER_TTL_DELETED: "#/components/schemas/OpCounterTtlDeletedRawMetricThresholdView"
          OPCOUNTER_UPDATE: "#/components/schemas/OpCounterUpdateRawMetricThresholdView"
          OPERATIONS_QUERIES_KILLED: "#/components/schemas/OperationsQueriesKilledRawMetricThresholdView"
          OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/OperationsScanAndOrderRawMetricThresholdView"
          OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/OperationThrottlingRejectedOperationsRawMetricThresholdView"
          OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/OplogMasterLagTimeDiffTimeMetricThresholdView"
          OPLOG_MASTER_TIME: "#/components/schemas/OplogMasterTimeTimeMetricThresholdView"
          OPLOG_MASTER_TIME_ESTIMATED_TTL: "#/components/schemas/OplogMasterTimeEstimatedTtlTimeMetricThresholdView"
          OPLOG_RATE_GB_PER_HOUR: "#/components/schemas/OplogRateGbPerHourDataMetricThresholdView"
          OPLOG_SLAVE_LAG_MASTER_TIME: "#/components/schemas/OplogSlaveLagMasterTimeTimeMetricThresholdView"
          QUERY_EXECUTOR_SCANNED: "#/components/schemas/QueryExecutorScannedRawMetricThresholdView"
          QUERY_EXECUTOR_SCANNED_OBJECTS: "#/components/schemas/QueryExecutorScannedObjectsRawMetricThresholdView"
          QUERY_SPILL_TO_DISK_DURING_SORT: "#/components/schemas/QuerySpillToDiskDuringSortRawMetricThresholdView"
          QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: "#/components/schemas/QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView"
          QUERY_TARGETING_SCANNED_PER_RETURNED: "#/components/schemas/QueryTargetingScannedPerReturnedRawMetricThresholdView"
          RESTARTS_IN_LAST_HOUR: "#/components/schemas/RestartsInLastHourRawMetricThresholdView"
          SEARCH_INDEX_SIZE: "#/components/schemas/SearchIndexSizeDataMetricThresholdView"
          SEARCH_MAX_FIELDS_INDEXED: "#/components/schemas/SearchMaxFieldsIndexedRawMetricThresholdView"
          SEARCH_MAX_NGRAM_FIELDS_INDEXED: "#/components/schemas/SearchMaxNgramFieldsIndexedRawMetricThresholdView"
          SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: "#/components/schemas/NumberMetricThresholdView"
          SEARCH_NUMBER_OF_FIELDS_IN_INDEX: "#/components/schemas/SearchNumberOfFieldsInIndexRawMetricThresholdView"
          SEARCH_NUMBER_OF_QUERIES_ERROR: "#/components/schemas/SearchNumberOfQueriesErrorRawMetricThresholdView"
          SEARCH_NUMBER_OF_QUERIES_SUCCESS: "#/components/schemas/SearchNumberOfQueriesSuccessRawMetricThresholdView"
          SEARCH_NUMBER_OF_QUERIES_TOTAL: "#/components/schemas/SearchNumberOfQueriesTotalRawMetricThresholdView"
          SEARCH_OPCOUNTER_DELETE: "#/components/schemas/SearchOpCounterDeleteRawMetricThresholdView"
          SEARCH_OPCOUNTER_GETMORE: "#/components/schemas/SearchOpCounterGetMoreRawMetricThresholdView"
          SEARCH_OPCOUNTER_INSERT: "#/components/schemas/SearchOpCounterInsertRawMetricThresholdView"
          SEARCH_OPCOUNTER_UPDATE: "#/components/schemas/SearchOpCounterUpdateRawMetricThresholdView"
          SEARCH_PROCESS_THROTTLING: "#/components/schemas/SearchProcessThrottlingRawMetricThresholdView"
          SEARCH_REPLICATION_LAG: "#/components/schemas/SearchReplicationLagTimeMetricThresholdView"
          SWAP_USAGE_FREE: "#/components/schemas/SwapUsageFreeDataMetricThresholdView"
          SWAP_USAGE_USED: "#/components/schemas/SwapUsageUsedDataMetricThresholdView"
          SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/SystemMemoryAvailableDataMetricThresholdView"
          SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/SystemMemoryPercentUsedRawMetricThresholdView"
          SYSTEM_MEMORY_USED: "#/components/schemas/SystemMemoryUsedDataMetricThresholdView"
          SYSTEM_NETWORK_IN: "#/components/schemas/SystemNetworkInDataMetricThresholdView"
          SYSTEM_NETWORK_OUT: "#/components/schemas/SystemNetworkOutDataMetricThresholdView"
          TICKETS_AVAILABLE_READS: "#/components/schemas/TicketsAvailableReadsRawMetricThresholdView"
          TICKETS_AVAILABLE_WRITES: "#/components/schemas/TicketsAvailableWritesRawMetricThresholdView"
        propertyName: metricName
      oneOf:
      - "$ref": "#/components/schemas/AssertRegularRawMetricThresholdView"
      - "$ref": "#/components/schemas/AssertWarningRawMetricThresholdView"
      - "$ref": "#/components/schemas/AssertMsgRawMetricThresholdView"
      - "$ref": "#/components/schemas/AssertUserRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterCmdRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterQueryRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterUpdateRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterDeleteRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterTtlDeletedRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterInsertRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterGetMoreRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterReplCmdRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterReplUpdateRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterReplDeleteRawMetricThresholdView"
      - "$ref": "#/components/schemas/OpCounterReplInsertRawMetricThresholdView"
      - "$ref": "#/components/schemas/FtsMemoryResidentDataMetricThresholdView"
      - "$ref": "#/components/schemas/FtsMemoryVirtualDataMetricThresholdView"
      - "$ref": "#/components/schemas/FtsMemoryMappedDataMetricThresholdView"
      - "$ref": "#/components/schemas/FtsProcessCpuUserRawMetricThresholdView"
      - "$ref": "#/components/schemas/FtsProcessCpuKernelRawMetricThresholdView"
      - "$ref": "#/components/schemas/NormalizedFtsProcessCpuUserRawMetricThresholdView"
      - "$ref": "#/components/schemas/NormalizedFtsProcessCpuKernelRawMetricThresholdView"
      - "$ref": "#/components/schemas/SystemMemoryPercentUsedRawMetricThresholdView"
      - "$ref": "#/components/schemas/MemoryResidentDataMetricThresholdView"
      - "$ref": "#/components/schemas/MemoryVirtualDataMetricThresholdView"
      - "$ref": "#/components/schemas/MemoryMappedDataMetricThresholdView"
      - "$ref": "#/components/schemas/ComputedMemoryDataMetricThresholdView"
      - "$ref": "#/components/schemas/IndexCountersBtreeAccessesRawMetricThresholdView"
      - "$ref": "#/components/schemas/IndexCountersBtreeHitsRawMetricThresholdView"
      - "$ref": "#/components/schemas/IndexCountersBtreeMissesRawMetricThresholdView"
      - "$ref": "#/components/schemas/IndexCountersBtreeMissRatioRawMetricThresholdView"
      - "$ref": "#/components/schemas/GlobalLockPercentageRawMetricThresholdView"
      - "$ref": "#/components/schemas/TimeMetricThresholdView"
      - "$ref": "#/components/schemas/ConnectionsRawMetricThresholdView"
      - "$ref": "#/components/schemas/ConnectionsMaxRawMetricThresholdView"
      - "$ref": "#/components/schemas/ConnectionsPercentRawMetricThresholdView"
      - "$ref": "#/components/schemas/GlobalAccessesNotInMemoryRawMetricThresholdView"
      - "$ref": "#/components/schemas/GlobalPageFaultExceptionsThrownRawMetricThresholdView"
      - "$ref": "#/components/schemas/GlobalLockCurrentQueueTotalRawMetricThresholdView"
      - "$ref": "#/components/schemas/GlobalLockCurrentQueueReadersRawMetricThresholdView"
      - "$ref": "#/components/schemas/GlobalLockCurrentQueueWritersRawMetricThresholdView"
      - "$ref": "#/components/schemas/CursorsTotalOpenRawMetricThresholdView"
      - "$ref": "#/components/schemas/CursorsTotalTimedOutRawMetricThresholdView"
      - "$ref": "#/components/schemas/CursorsTotalClientCursorsSizeRawMetricThresholdView"
      - "$ref": "#/components/schemas/NetworkBytesInDataMetricThresholdView"
      - "$ref": "#/components/schemas/NetworkBytesOutDataMetricThresholdView"
      - "$ref": "#/components/schemas/NetworkNumRequestsRawMetricThresholdView"
      - "$ref": "#/components/schemas/OplogMasterTimeTimeMetricThresholdView"
      - "$ref": "#/components/schemas/OplogMasterTimeEstimatedTtlTimeMetricThresholdView"
      - "$ref": "#/components/schemas/OplogSlaveLagMasterTimeTimeMetricThresholdView"
      - "$ref": "#/components/schemas/OplogMasterLagTimeDiffTimeMetricThresholdView"
      - "$ref": "#/components/schemas/OplogRateGbPerHourDataMetricThresholdView"
      - "$ref": "#/components/schemas/ExtraInfoPageFaultsRawMetricThresholdView"
      - "$ref": "#/components/schemas/DbStorageTotalDataMetricThresholdView"
      - "$ref": "#/components/schemas/DbDataSizeTotalDataMetricThresholdView"
      - "$ref": "#/components/schemas/DbDataSizeTotalWoSystemDataMetricThresholdView"
      - "$ref": "#/components/schemas/DbIndexSizeTotalDataMetricThresholdView"
      - "$ref": "#/components/schemas/JournalingCommitsInWriteLockRawMetricThresholdView"
      - "$ref": "#/components/schemas/JournalingMbDataMetricThresholdView"
      - "$ref": "#/components/schemas/JournalingWriteDataFilesMbDataMetricThresholdView"
      - "$ref": "#/components/schemas/TicketsAvailableReadsRawMetricThresholdView"
      - "$ref": "#/components/schemas/TicketsAvailableWritesRawMetricThresholdView"
      - "$ref": "#/components/schemas/CacheUsageDirtyDataMetricThresholdView"
      - "$ref": "#/components/schemas/CacheUsageUsedDataMetricThresholdView"
      - "$ref": "#/components/schemas/CacheBytesReadIntoDataMetricThresholdView"
      - "$ref": "#/components/schemas/CacheBytesWrittenFromDataMetricThresholdView"
      - "$ref": "#/components/schemas/NormalizedSystemCpuUserRawMetricThresholdView"
      - "$ref": "#/components/schemas/NormalizedSystemCpuStealRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionSpaceUsedDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionSpaceUsedIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionSpaceUsedJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionReadIopsDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionReadIopsIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionReadIopsJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionWriteIopsDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionWriteIopsIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionWriteIopsJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionReadLatencyDataTimeMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionReadLatencyIndexTimeMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionReadLatencyJournalTimeMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionWriteLatencyDataTimeMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionWriteLatencyIndexTimeMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionWriteLatencyJournalTimeMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionQueueDepthDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionQueueDepthIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/DiskPartitionQueueDepthJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/FtsDiskUtilizationDataMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuUserRawMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuNiceRawMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuSystemRawMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuIowaitRawMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuIrqRawMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuSoftirqRawMetricThresholdView"
      - "$ref": "#/components/schemas/MuninCpuStealRawMetricThresholdView"
      - "$ref": "#/components/schemas/DocumentReturnedRawMetricThresholdView"
      - "$ref": "#/components/schemas/DocumentInsertedRawMetricThresholdView"
      - "$ref": "#/components/schemas/DocumentUpdatedRawMetricThresholdView"
      - "$ref": "#/components/schemas/DocumentDeletedRawMetricThresholdView"
      - "$ref": "#/components/schemas/OperationsScanAndOrderRawMetricThresholdView"
      - "$ref": "#/components/schemas/QueryExecutorScannedRawMetricThresholdView"
      - "$ref": "#/components/schemas/QueryExecutorScannedObjectsRawMetricThresholdView"
      - "$ref": "#/components/schemas/OperationThrottlingRejectedOperationsRawMetricThresholdView"
      - "$ref": "#/components/schemas/QuerySpillToDiskDuringSortRawMetricThresholdView"
      - "$ref": "#/components/schemas/OperationsQueriesKilledRawMetricThresholdView"
      - "$ref": "#/components/schemas/QueryTargetingScannedPerReturnedRawMetricThresholdView"
      - "$ref": "#/components/schemas/QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView"
      - "$ref": "#/components/schemas/AvgReadExecutionTimeTimeMetricThresholdView"
      - "$ref": "#/components/schemas/AvgWriteExecutionTimeTimeMetricThresholdView"
      - "$ref": "#/components/schemas/AvgCommandExecutionTimeTimeMetricThresholdView"
      - "$ref": "#/components/schemas/LogicalSizeDataMetricThresholdView"
      - "$ref": "#/components/schemas/RestartsInLastHourRawMetricThresholdView"
      - "$ref": "#/components/schemas/SystemMemoryUsedDataMetricThresholdView"
      - "$ref": "#/components/schemas/SystemMemoryAvailableDataMetricThresholdView"
      - "$ref": "#/components/schemas/SwapUsageUsedDataMetricThresholdView"
      - "$ref": "#/components/schemas/SwapUsageFreeDataMetricThresholdView"
      - "$ref": "#/components/schemas/SystemNetworkInDataMetricThresholdView"
      - "$ref": "#/components/schemas/SystemNetworkOutDataMetricThresholdView"
      - "$ref": "#/components/schemas/MaxNormalizedSystemCpuUserRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxNormalizedSystemCpuStealRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionSpaceUsedDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionReadIopsDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionReadIopsIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionReadIopsJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionWriteIopsDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionWriteIopsIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionWriteIopsJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionReadLatencyDataTimeMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionQueueDepthDataRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionQueueDepthIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxDiskPartitionQueueDepthJournalRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSystemMemoryPercentUsedRawMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSystemMemoryUsedDataMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSystemMemoryAvailableDataMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSwapUsageUsedDataMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSwapUsageFreeDataMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSystemNetworkInDataMetricThresholdView"
      - "$ref": "#/components/schemas/MaxSystemNetworkOutDataMetricThresholdView"
      - "$ref": "#/components/schemas/SearchIndexSizeDataMetricThresholdView"
      - "$ref": "#/components/schemas/SearchMaxFieldsIndexedRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchProcessThrottlingRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchNumberOfFieldsInIndexRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchMaxNgramFieldsIndexedRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchReplicationLagTimeMetricThresholdView"
      - "$ref": "#/components/schemas/NumberMetricThresholdView"
      - "$ref": "#/components/schemas/SearchOpCounterInsertRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchOpCounterDeleteRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchOpCounterUpdateRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchOpCounterGetMoreRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchNumberOfQueriesTotalRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchNumberOfQueriesErrorRawMetricThresholdView"
      - "$ref": "#/components/schemas/SearchNumberOfQueriesSuccessRawMetricThresholdView"
      - "$ref": "#/components/schemas/FtsJvmMaxMemoryDataMetricThresholdView"
      - "$ref": "#/components/schemas/FtsJvmCurrentMemoryDataMetricThresholdView"
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      required:
      - metricName
      title: Host Metric Threshold
      type: object
    HostMetricValue:
      description: Value of the metric that triggered the alert. The resource returns
        this parameter for alerts of events impacting hosts.
      properties:
        number:
          description: Amount of the `metricName` recorded at the time of the event.
            This value triggered the alert.
          format: double
          readOnly: true
          type: number
        units:
          description: Element used to express the quantity in `currentValue.number`.
            This can be an element of time, storage capacity, and the like. This metric
            triggered the alert.
          enum:
          - bits
          - Kbits
          - Mbits
          - Gbits
          - bytes
          - KB
          - MB
          - GB
          - TB
          - PB
          - nsec
          - msec
          - sec
          - min
          - hours
          - million minutes
          - days
          - requests
          - 1000 requests
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          readOnly: true
          type: string
      readOnly: true
      type: object
    InboundControlPlaneCloudProviderIPAddresses:
      description: List of inbound IP addresses to the Atlas control plane, categorized
        by cloud provider. If your application allows outbound HTTP requests only
        to specific IP addresses, you must allow access to the following IP addresses
        so that your API requests can reach the Atlas control plane.
      properties:
        aws:
          additionalProperties:
            description: Control plane IP addresses in AWS. Each key identifies an
              Amazon Web Services (AWS) region. Each value identifies control plane
              IP addresses in the AWS region.
            items:
              description: Control plane IP addresses in AWS. Each key identifies
                an Amazon Web Services (AWS) region. Each value identifies control
                plane IP addresses in the AWS region.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: Control plane IP addresses in AWS. Each key identifies an Amazon
            Web Services (AWS) region. Each value identifies control plane IP addresses
            in the AWS region.
          readOnly: true
          type: object
        azure:
          additionalProperties:
            description: Control plane IP addresses in Azure. Each key identifies
              an Azure region. Each value identifies control plane IP addresses in
              the Azure region.
            items:
              description: Control plane IP addresses in Azure. Each key identifies
                an Azure region. Each value identifies control plane IP addresses
                in the Azure region.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: Control plane IP addresses in Azure. Each key identifies an
            Azure region. Each value identifies control plane IP addresses in the
            Azure region.
          readOnly: true
          type: object
        gcp:
          additionalProperties:
            description: Control plane IP addresses in GCP. Each key identifies a
              Google Cloud (GCP) region. Each value identifies control plane IP addresses
              in the GCP region.
            items:
              description: Control plane IP addresses in GCP. Each key identifies
                a Google Cloud (GCP) region. Each value identifies control plane IP
                addresses in the GCP region.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: Control plane IP addresses in GCP. Each key identifies a Google
            Cloud (GCP) region. Each value identifies control plane IP addresses in
            the GCP region.
          readOnly: true
          type: object
      readOnly: true
      title: Inbound Control Plane IP Addresses By Cloud Provider
      type: object
    IndexCountersBtreeAccessesRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    IndexCountersBtreeHitsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    IndexCountersBtreeMissRatioRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    IndexCountersBtreeMissesRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    IndexOptions:
      description: One or more settings that determine how the MongoDB Cloud creates
        this MongoDB index.
      externalDocs:
        description: Index Options
        url: https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options
      properties:
        2dsphereIndexVersion:
          default: 3
          description: Index version number applied to the 2dsphere index. MongoDB
            3.2 and later use version 3. Use this option to override the default version
            number. This option applies to the **2dsphere** index type only.
          format: int32
          type: integer
        background:
          default: false
          description: Flag that indicates whether MongoDB should build the index
            in the background. This applies to MongoDB databases running feature compatibility
            version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build
            indexes using an optimized build process. This process holds the exclusive
            lock only at the beginning and end of the build process. The rest of the
            build process yields to interleaving read and write operations. MongoDB
            databases running FCV 4.2 or later ignore this option. This option applies
            to all index types.
          type: boolean
        bits:
          default: 26
          description: Number of precision applied to the stored geohash value of
            the location data. This option applies to the **2d** index type only.
          format: int32
          type: integer
        bucketSize:
          description: |-
            Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.

            MongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command.
          format: int32
          type: integer
        columnstoreProjection:
          additionalProperties:
            description: |-
              The `columnstoreProjection` document allows to include or exclude sub-schemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the <value> can be either of the following:
              1 or true to include the field and recursively all fields it is a prefix of in the index
              0 or false to exclude the field and recursively all fields it is a prefix of from the index.
            format: int32
            type: integer
          description: |-
            The `columnstoreProjection` document allows to include or exclude sub-schemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the <value> can be either of the following:
            1 or true to include the field and recursively all fields it is a prefix of in the index
            0 or false to exclude the field and recursively all fields it is a prefix of from the index.
          type: object
        default_language:
          default: english
          description: Human language that determines the list of stop words and the
            rules for the stemmer and tokenizer. This option accepts the supported
            languages using its name in lowercase English or the ISO 639-2 code. If
            you set this parameter to `"none"`, then the text search uses simple tokenization
            with no list of stop words and no stemming. This option applies to the
            **text** index type only.
          type: string
        expireAfterSeconds:
          description: Number of seconds that MongoDB retains documents in a Time
            To Live (TTL) index.
          format: int32
          type: integer
        hidden:
          default: false
          description: Flag that determines whether the index is hidden from the query
            planner. A hidden index is not evaluated as part of the query plan selection.
          type: boolean
        language_override:
          default: language
          description: Human-readable label that identifies the document parameter
            that contains the override language for the document. This option applies
            to the **text** index type only.
          type: string
        max:
          default: 180
          description: Upper inclusive boundary to limit the longitude and latitude
            values. This option applies to the 2d index type only.
          format: int32
          type: integer
        min:
          default: -180
          description: Lower inclusive boundary to limit the longitude and latitude
            values. This option applies to the 2d index type only.
          format: int32
          type: integer
        name:
          description: Human-readable label that identifies this index. This option
            applies to all index types.
          type: string
        partialFilterExpression:
          additionalProperties:
            description: |-
              Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a `partialFilterExpression` option. `partialFilterExpression` can include following expressions:

              - equality (`"parameter" : "value"` or using the `$eq` operator)
              - `"$exists": true`
              , maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons
              - `$type`
              - `$and` (top-level only)
               This option applies to all index types.
            type: object
          description: |-
            Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a `partialFilterExpression` option. `partialFilterExpression` can include following expressions:

            - equality (`"parameter" : "value"` or using the `$eq` operator)
            - `"$exists": true`
            , maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons
            - `$type`
            - `$and` (top-level only)
             This option applies to all index types.
          type: object
        sparse:
          default: false
          description: |-
            Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.

            Compound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types.
          type: boolean
        storageEngine:
          additionalProperties:
            description: 'Storage engine set for the specific index. This value can
              be set only at creation. This option uses the following format: `"storageEngine"
              : { "<storage-engine-name>" : "<options>" }` MongoDB validates storage
              engine configuration options when creating indexes. To support replica
              sets with members with different storage engines, MongoDB logs these
              options to the oplog during replication. This option applies to all
              index types.'
            externalDocs:
              description: MongoDB Server Storage Engines
              url: https://docs.mongodb.com/manual/core/storage-engines/
            type: object
          description: 'Storage engine set for the specific index. This value can
            be set only at creation. This option uses the following format: `"storageEngine"
            : { "<storage-engine-name>" : "<options>" }` MongoDB validates storage
            engine configuration options when creating indexes. To support replica
            sets with members with different storage engines, MongoDB logs these options
            to the oplog during replication. This option applies to all index types.'
          externalDocs:
            description: MongoDB Server Storage Engines
            url: https://docs.mongodb.com/manual/core/storage-engines/
          type: object
        textIndexVersion:
          default: 3
          description: Version applied to this text index. MongoDB 3.2 and later use
            version `3`. Use this option to override the default version number. This
            option applies to the **text** index type only.
          format: int32
          type: integer
        weights:
          additionalProperties:
            description: Relative importance to place upon provided index parameters.
              This object expresses this as key/value pairs of index parameter and
              weight to apply to that parameter. You can specify weights for some
              or all the indexed parameters. The weight must be an integer between
              1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text**
              indexes only.
            type: object
          description: Relative importance to place upon provided index parameters.
            This object expresses this as key/value pairs of index parameter and weight
            to apply to that parameter. You can specify weights for some or all the
            indexed parameters. The weight must be an integer between 1 and 99,999.
            MongoDB 5.0 and later can apply **weights** to **text** indexes only.
          type: object
      type: object
      writeOnly: true
    IngestionPipelineRun:
      description: Run details of a Data Lake Pipeline.
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies a Data
            Lake Pipeline run.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        backupFrequencyType:
          description: Backup schedule interval of the Data Lake Pipeline.
          enum:
          - HOURLY
          - DAILY
          - WEEKLY
          - MONTHLY
          - YEARLY
          - ON_DEMAND
          readOnly: true
          type: string
        createdDate:
          description: Timestamp that indicates when the pipeline run was created.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        datasetName:
          description: Human-readable label that identifies the dataset that Atlas
            generates during this pipeline run. You can use this dataset as a `dataSource`
            in a Federated Database collection.
          example: v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z
          readOnly: true
          type: string
        datasetRetentionPolicy:
          "$ref": "#/components/schemas/DatasetRetentionPolicy"
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastUpdatedDate:
          description: Timestamp that indicates the last time that the pipeline run
            was updated. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          format: date-time
          readOnly: true
          type: string
        phase:
          description: Processing phase of the Data Lake Pipeline.
          enum:
          - SNAPSHOT
          - EXPORT
          - INGESTION
          readOnly: true
          type: string
        pipelineId:
          description: Unique 24-hexadecimal character string that identifies a Data
            Lake Pipeline.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        scheduledDeletionDate:
          description: Timestamp that indicates when the pipeline run will expire
            and its dataset will be deleted. This parameter expresses its value in
            the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        snapshotId:
          description: Unique 24-hexadecimal character string that identifies the
            snapshot of a cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        state:
          description: State of the pipeline run.
          enum:
          - PENDING
          - IN_PROGRESS
          - DONE
          - FAILED
          - DATASET_DELETED
          readOnly: true
          type: string
        stats:
          "$ref": "#/components/schemas/PipelineRunStats"
      title: Data Lake Pipeline Run
      type: object
    IngestionSink:
      description: Ingestion destination of a Data Lake Pipeline.
      discriminator:
        mapping:
          DLS: "#/components/schemas/DLSIngestionSink"
        propertyName: type
      properties:
        type:
          description: Type of ingestion destination of this Data Lake Pipeline.
          enum:
          - DLS
          readOnly: true
          type: string
      title: Ingestion Destination
      type: object
    IngestionSource:
      description: Ingestion Source of a Data Lake Pipeline.
      discriminator:
        mapping:
          ON_DEMAND_CPS: "#/components/schemas/OnDemandCpsSnapshotSource"
          PERIODIC_CPS: "#/components/schemas/PeriodicCpsSnapshotSource"
        propertyName: type
      properties:
        type:
          description: Type of ingestion source of this Data Lake Pipeline.
          enum:
          - PERIODIC_CPS
          - ON_DEMAND_CPS
          type: string
      title: Ingestion Source
      type: object
    InvoiceLineItem:
      description: One service included in this invoice.
      properties:
        clusterName:
          description: Human-readable label that identifies the cluster that incurred
            the charge.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this line item. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        discountCents:
          description: Sum by which MongoDB discounted this line item. MongoDB Cloud
            expresses this value in cents (100ths of one US Dollar). The resource
            returns this parameter when a discount applies.
          format: int64
          readOnly: true
          type: integer
        endDate:
          description: Date and time when when MongoDB Cloud finished charging for
            this line item. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            associated to this line item.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        groupName:
          description: Human-readable label that identifies the project.
          type: string
        note:
          description: Comment that applies to this line item.
          readOnly: true
          type: string
        percentDiscount:
          description: Percentage by which MongoDB discounted this line item. The
            resource returns this parameter when a discount applies.
          format: float
          readOnly: true
          type: number
        quantity:
          description: Number of units included for the line item. These can be expressions
            of storage (GB), time (hours), or other units.
          format: double
          readOnly: true
          type: number
        sku:
          description: Human-readable description of the service that this line item
            provided. This Stock Keeping Unit (SKU) could be the instance type, a
            support charge, advanced security, or another service.
          externalDocs:
            description: To see how to list all possible values, click here.
            url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listSkus
          readOnly: true
          type: string
        startDate:
          description: Date and time when MongoDB Cloud began charging for this line
            item. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC.
          format: date-time
          readOnly: true
          type: string
        stitchAppName:
          description: Human-readable label that identifies the Atlas App Services
            application associated with this line item.
          externalDocs:
            description: Create a new Atlas App Service
            url: https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/
          readOnly: true
          type: string
        tags:
          additionalProperties:
            description: A map of key-value pairs corresponding to the tags associated
              with the line item resource.
            items:
              description: A map of key-value pairs corresponding to the tags associated
                with the line item resource.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: A map of key-value pairs corresponding to the tags associated
            with the line item resource.
          readOnly: true
          type: object
        tierLowerBound:
          description: "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**:
            `lineItems[n].tierLowerBound` appears only if your `lineItems[n].sku`
            is tiered."
          format: double
          readOnly: true
          type: number
        tierUpperBound:
          description: "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**:
            `lineItems[n].tierUpperBound` appears only if your `lineItems[n].sku`
            is tiered."
          format: double
          readOnly: true
          type: number
        totalPriceCents:
          description: Sum of the cost set for this line item. MongoDB Cloud expresses
            this value in cents (100ths of one US Dollar) and calculates this value
            as `unitPriceDollars` * `quantity` * 100.
          format: int64
          readOnly: true
          type: integer
        unit:
          description: Element used to express what **quantity** this line item measures.
            This value can be elements of time, storage capacity, and the like.
          readOnly: true
          type: string
        unitPriceDollars:
          description: Value per **unit** for this line item expressed in US Dollars.
          format: double
          readOnly: true
          type: number
      title: Line Item
      type: object
    JournalingCommitsInWriteLockRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    JournalingMbDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    JournalingWriteDataFilesMbDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    KafkaRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    LDAPSecuritySettings:
      description: Lightweight Directory Access Protocol (LDAP) over Transport Layer
        Security (TLS) configuration details that apply to the specified project.
      properties:
        authenticationEnabled:
          description: Flag that indicates whether users can authenticate using an
            Lightweight Directory Access Protocol (LDAP) host.
          type: boolean
        authorizationEnabled:
          description: Flag that indicates whether users can authorize access to MongoDB
            Cloud resources using an Lightweight Directory Access Protocol (LDAP)
            host.
          type: boolean
        authzQueryTemplate:
          default: "{USER}?memberOf?base"
          description: Lightweight Directory Access Protocol (LDAP) query template
            that MongoDB Cloud runs to obtain the LDAP groups associated with the
            authenticated user. MongoDB Cloud uses this parameter only for user authorization.
            Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to
            substitute the authenticated username. The query relates to the host specified
            with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515)
            and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).
          example: "{USER}?memberOf?base"
          type: string
        bindPassword:
          description: Password that MongoDB Cloud uses to authenticate the `bindUsername`.
          type: string
          writeOnly: true
        bindUsername:
          description: Full Distinguished Name (DN) of the Lightweight Directory Access
            Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host.
            LDAP distinguished names must be formatted according to RFC 2253.
          example: CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com
          externalDocs:
            description: RFC 2253
            url: https://tools.ietf.org/html/2253
          pattern: "^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$"
          type: string
        caCertificate:
          description: 'Certificate Authority (CA) certificate that MongoDB Cloud
            uses to verify the identity of the Lightweight Directory Access Protocol
            (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete
            an assigned value, pass an empty string: `"caCertificate": ""`.'
          type: string
        hostname:
          description: Human-readable label that identifies the hostname or Internet
            Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP)
            host. This host must have access to the internet or have a Virtual Private
            Cloud (VPC) peering connection to your cluster.
          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]+)?$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        port:
          default: 636
          description: Port to which the Lightweight Directory Access Protocol (LDAP)
            host listens for client connections.
          format: int32
          type: integer
        userToDNMapping:
          description: User-to-Distinguished Name (DN) map that MongoDB Cloud uses
            to transform a Lightweight Directory Access Protocol (LDAP) username into
            an LDAP DN.
          items:
            "$ref": "#/components/schemas/UserToDNMapping"
          type: array
      title: LDAP Security Settings
      type: object
    LDAPVerifyConnectivityJobRequest:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            associated with this Lightweight Directory Access Protocol (LDAP) over
            Transport Layer Security (TLS) configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        request:
          "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequestParams"
        requestId:
          description: Unique 24-hexadecimal digit string that identifies this request
            to verify an Lightweight Directory Access Protocol (LDAP) configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        status:
          description: Human-readable string that indicates the status of the Lightweight
            Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.
          enum:
          - FAIL
          - PENDING
          - SUCCESS
          readOnly: true
          type: string
        validations:
          description: List that contains the validation messages related to the verification
            of the provided Lightweight Directory Access Protocol (LDAP) over Transport
            Layer Security (TLS) configuration details. The list contains a document
            for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests
            after the first failure.
          items:
            "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation"
          readOnly: true
          type: array
      type: object
    LDAPVerifyConnectivityJobRequestParams:
      description: Request information needed to verify an Lightweight Directory Access
        Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response
        does not return the `bindPassword`.
      properties:
        authzQueryTemplate:
          default: "{USER}?memberOf?base"
          description: |-
            Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.

            Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).
          example: "{USER}?memberOf?base"
          type: string
          writeOnly: true
        bindPassword:
          description: Password that MongoDB Cloud uses to authenticate the `bindUsername`.
          type: string
          writeOnly: true
        bindUsername:
          description: Full Distinguished Name (DN) of the Lightweight Directory Access
            Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host.
            LDAP distinguished names must be formatted according to RFC 2253.
          example: CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com
          externalDocs:
            description: RFC 2253
            url: https://tools.ietf.org/html/2253
          pattern: "^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$"
          type: string
        caCertificate:
          description: 'Certificate Authority (CA) certificate that MongoDB Cloud
            uses to verify the identity of the Lightweight Directory Access Protocol
            (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete
            an assigned value, pass an empty string: `"caCertificate": ""`.'
          type: string
        hostname:
          description: Human-readable label that identifies the hostname or Internet
            Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP)
            host. This host must have access to the internet or have a Virtual Private
            Cloud (VPC) peering connection to your cluster.
          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]+)?$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        port:
          default: 636
          description: IANA port to which the Lightweight Directory Access Protocol
            (LDAP) host listens for client connections.
          format: int32
          type: integer
      required:
      - bindPassword
      - bindUsername
      - hostname
      - port
      type: object
    LDAPVerifyConnectivityJobRequestValidation:
      description: One test that MongoDB Cloud runs to test verification of the provided
        Lightweight Directory Access Protocol (LDAP) over Transport Layer Security
        (TLS) configuration details.
      properties:
        status:
          description: Human-readable string that indicates the result of this verification
            test.
          enum:
          - FAIL
          - OK
          readOnly: true
          type: string
        validationType:
          description: Human-readable label that identifies this verification test
            that MongoDB Cloud runs.
          enum:
          - AUTHENTICATE
          - AUTHORIZATION_ENABLED
          - CONNECT
          - PARSE_AUTHZ_QUERY
          - QUERY_SERVER
          - SERVER_SPECIFIED
          - TEMPLATE
          readOnly: true
          type: string
      readOnly: true
      type: object
    LegacyAtlasCluster:
      description: Group of settings that configure a MongoDB cluster.
      properties:
        acceptDataRisksAndForceReplicaSetReconfig:
          description: If reconfiguration is necessary to regain a primary due to
            a regional outage, submit this field alongside your topology reconfiguration
            to request a new regional outage resistant topology. Forced reconfigurations
            during an outage of the majority of electable nodes carry a risk of data
            loss if replicated writes (even majority committed writes) have not been
            replicated to the new primary node. MongoDB Atlas docs contain more information.
            To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig`
            to the current date. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          externalDocs:
            description: Reconfiguring a Replica Set during a regional outage
            url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set
          format: date-time
          type: string
        advancedConfiguration:
          "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView"
        autoScaling:
          "$ref": "#/components/schemas/ClusterAutoScalingSettings"
        backupEnabled:
          description: Flag that indicates whether the cluster can perform backups.
            If set to `true`, the cluster can perform backups. You must set this value
            to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters
            and Shared Cluster Backups for tenant clusters. If set to `false`, the
            cluster doesn't use MongoDB Cloud backups.
          type: boolean
        biConnector:
          "$ref": "#/components/schemas/BiConnector"
        clusterType:
          description: Configuration of nodes that comprise the cluster.
          enum:
          - REPLICASET
          - SHARDED
          - GEOSHARDED
          type: string
        configServerManagementMode:
          default: ATLAS_MANAGED
          description: Config Server Management Mode for creating or updating a sharded
            cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch
            the cluster's config server type for optimal performance and savings.
            When configured as `FIXED_TO_DEDICATED`, the cluster will always use a
            dedicated config server.
          enum:
          - ATLAS_MANAGED
          - FIXED_TO_DEDICATED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          type: string
        configServerType:
          description: Describes a sharded cluster's config server type.
          enum:
          - DEDICATED
          - EMBEDDED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          readOnly: true
          type: string
        connectionStrings:
          "$ref": "#/components/schemas/ClusterConnectionStrings"
        createDate:
          description: Date and time when MongoDB Cloud created this serverless instance.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        deleteAfterCreationHours:
          description: |-
            Number of hours after cluster creation that this cluster will be automatically deleted.

            This field is used to derive `deleteAfterDate` relative to `createDate`.

            When set to null or zero on cluster creation, the cluster will not be automatically deleted.

            When set to a positive value on cluster creation, the cluster will be automatically deleted after the specified number of hours.

            When updating this field on an existing (non-deleted) cluster, and this is set to null, then existing values are preserved for this & `deleteAfterDate`.

            When updating this field on an existing (non-deleted) cluster, and this is set to zero, then `deleteAfterDate` is reset to null (disable auto deletion) regardless of previous configurations.

            When updating this field on an existing (non-deleted) cluster, and this is set to a positive value, then `createDate` + `deleteAfterCreationHours` must be later than now else the field update is ignored and existing values are preserved for this & `deleteAfterDate`.
          format: int32
          type: integer
        deleteAfterDate:
          description: |-
            The date at which this cluster will be automatically deleted.

            This parameter expresses its value in the ISO 8601 timestamp format in UTC and is derived based on the `createDate` + `deleteAfterCreationHours`.
          format: date-time
          readOnly: true
          type: string
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value is not configurable
            on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you
            set `replicationSpecs`.\n\n If you specify a disk size below the minimum
            (10 GB), this parameter defaults to the minimum disk size value. \n\n
            Storage charge calculations depend on whether you choose the default value
            or a custom value.\n\n The maximum value for disk storage cannot exceed
            50 times the maximum RAM for the selected cluster. If you require more
            storage space, consider upgrading your cluster to a higher tier."
          format: double
          maximum: 4096
          minimum: 10
          type: number
        diskWarmingMode:
          default: FULLY_WARMED
          description: Disk warming mode selection.
          enum:
          - FULLY_WARMED
          - VISIBLE_EARLIER
          externalDocs:
            description: Reduce Secondary Disk Warming Impact
            url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact
          type: string
        encryptionAtRestProvider:
          description: 'Cloud service provider that manages your customer keys to
            provide an additional layer of encryption at rest for the cluster. To
            enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize`
            setting must be `M10` or higher and `"backupEnabled" : false` or omitted
            entirely.'
          enum:
          - NONE
          - AWS
          - AZURE
          - GCP
          externalDocs:
            description: Encryption at Rest using Customer Key Management
            url: https://www.mongodb.com/docs/atlas/security-kms-encryption/
          type: string
        featureCompatibilityVersion:
          description: Feature compatibility version of the cluster.
          readOnly: true
          type: string
        featureCompatibilityVersionExpirationDate:
          description: Feature compatibility version expiration date. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        globalClusterSelfManagedSharding:
          description: |-
            Set this field to configure the Sharding Management Mode when creating a new Global Cluster.

            When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.

            When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.

            This setting cannot be changed once the cluster is deployed.
          externalDocs:
            description: Creating a Global Cluster
            url: https://dochub.mongodb.org/core/global-cluster-management
          type: boolean
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        labels:
          deprecated: true
          description: |-
            Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

            Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ComponentLabel"
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBEmployeeAccessGrant:
          "$ref": "#/components/schemas/EmployeeAccessGrantView"
        mongoDBMajorVersion:
          description: |-
            MongoDB major version of the cluster.

            On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).

             On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
          example: '5.0'
          externalDocs:
            description: Available MongoDB Versions in Atlas
            url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-
          type: string
        mongoDBVersion:
          description: Version of MongoDB that the cluster runs.
          example: 5.0.25
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          type: string
        mongoURI:
          description: Base connection string that you can use to connect to the cluster.
            MongoDB Cloud displays the string only after the cluster starts, not while
            it builds the cluster.
          externalDocs:
            description: Connection string URI format.
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        mongoURIUpdated:
          description: Date and time when someone last updated the connection string.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        mongoURIWithOptions:
          description: Connection string that you can use to connect to the cluster
            including the `replicaSet`, `ssl`, and `authSource` query parameters with
            values appropriate for the cluster. You may need to add MongoDB database
            users. The response returns this parameter once the cluster can receive
            requests, not while it builds the cluster.
          externalDocs:
            description: Connection string URI format.
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the cluster.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        numShards:
          default: 1
          description: Number of shards up to 50 to deploy for a sharded cluster.
            The resource returns `1` to indicate a replica set and values of `2` and
            higher to indicate a sharded cluster. The returned value equals the number
            of shards in the cluster.
          externalDocs:
            description: Sharding
            url: https://docs.mongodb.com/manual/sharding/
          format: int32
          maximum: 50
          minimum: 1
          type: integer
        paused:
          description: Flag that indicates whether the cluster is paused.
          type: boolean
        pitEnabled:
          description: Flag that indicates whether the cluster uses continuous cloud
            backups.
          externalDocs:
            description: Continuous Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        providerBackupEnabled:
          description: Flag that indicates whether the M10 or higher cluster can perform
            Cloud Backups. If set to `true`, the cluster can perform backups. If this
            and `backupEnabled` are set to `false`, the cluster doesn't use MongoDB
            Cloud backups.
          type: boolean
        providerSettings:
          "$ref": "#/components/schemas/ClusterProviderSettings"
        replicaSetScalingStrategy:
          default: WORKLOAD_TYPE
          description: |-
            Set this field to configure the replica set scaling mode for your cluster.

            By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.

            When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.

            When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
          enum:
          - SEQUENTIAL
          - WORKLOAD_TYPE
          - NODE_TYPE
          externalDocs:
            description: Modify the Replica Set Scaling Mode
            url: https://dochub.mongodb.org/core/scale-nodes
          type: string
        replicationFactor:
          default: 3
          deprecated: true
          description: Number of members that belong to the replica set. Each member
            retains a copy of your databases, providing high availability and data
            redundancy. Use `replicationSpecs` instead.
          enum:
          - 3
          - 5
          - 7
          format: int32
          type: integer
        replicationSpec:
          additionalProperties:
            "$ref": "#/components/schemas/RegionSpec"
          description: Physical location where MongoDB Cloud provisions cluster nodes.
          title: Region Configuration
          type: object
        replicationSpecs:
          description: |-
            List of settings that configure your cluster regions.

            - For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
            - For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
          items:
            "$ref": "#/components/schemas/LegacyReplicationSpec"
          type: array
        rootCertType:
          default: ISRGROOTX1
          description: Root Certificate Authority that MongoDB Atlas cluster uses.
            MongoDB Cloud supports Internet Security Research Group.
          enum:
          - ISRGROOTX1
          type: string
        srvAddress:
          description: Connection string that you can use to connect to the cluster.
            The `+srv` modifier forces the connection to use Transport Layer Security
            (TLS). The `mongoURI` parameter lists additional options.
          externalDocs:
            description: Connection string URI format.
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        stateName:
          description: |-
            Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

             - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
             - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
             - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
             - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
             - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the cluster.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
        versionReleaseSystem:
          default: LTS
          description: Method by which the cluster maintains the MongoDB versions.
            If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`.
          enum:
          - LTS
          - CONTINUOUS
          type: string
      title: Cluster Description
      type: object
    LegacyAtlasTenantClusterUpgradeRequest:
      description: Request containing target state of tenant cluster to be upgraded.
      properties:
        acceptDataRisksAndForceReplicaSetReconfig:
          description: If reconfiguration is necessary to regain a primary due to
            a regional outage, submit this field alongside your topology reconfiguration
            to request a new regional outage resistant topology. Forced reconfigurations
            during an outage of the majority of electable nodes carry a risk of data
            loss if replicated writes (even majority committed writes) have not been
            replicated to the new primary node. MongoDB Atlas docs contain more information.
            To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig`
            to the current date. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          externalDocs:
            description: Reconfiguring a Replica Set during a regional outage
            url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set
          format: date-time
          type: string
        advancedConfiguration:
          "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView"
        autoScaling:
          "$ref": "#/components/schemas/ClusterAutoScalingSettings"
        backupEnabled:
          description: Flag that indicates whether the cluster can perform backups.
            If set to `true`, the cluster can perform backups. You must set this value
            to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters
            and Shared Cluster Backups for tenant clusters. If set to `false`, the
            cluster doesn't use MongoDB Cloud backups.
          type: boolean
        biConnector:
          "$ref": "#/components/schemas/BiConnector"
        clusterType:
          description: Configuration of nodes that comprise the cluster.
          enum:
          - REPLICASET
          - SHARDED
          - GEOSHARDED
          type: string
        configServerManagementMode:
          default: ATLAS_MANAGED
          description: Config Server Management Mode for creating or updating a sharded
            cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch
            the cluster's config server type for optimal performance and savings.
            When configured as `FIXED_TO_DEDICATED`, the cluster will always use a
            dedicated config server.
          enum:
          - ATLAS_MANAGED
          - FIXED_TO_DEDICATED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          type: string
        configServerType:
          description: Describes a sharded cluster's config server type.
          enum:
          - DEDICATED
          - EMBEDDED
          externalDocs:
            description: MongoDB Sharded Cluster Config Servers
            url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers
          readOnly: true
          type: string
        connectionStrings:
          "$ref": "#/components/schemas/ClusterConnectionStrings"
        createDate:
          description: Date and time when MongoDB Cloud created this serverless instance.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        deleteAfterCreationHours:
          description: |-
            Number of hours after cluster creation that this cluster will be automatically deleted.

            This field is used to derive `deleteAfterDate` relative to `createDate`.

            When set to null or zero on cluster creation, the cluster will not be automatically deleted.

            When set to a positive value on cluster creation, the cluster will be automatically deleted after the specified number of hours.

            When updating this field on an existing (non-deleted) cluster, and this is set to null, then existing values are preserved for this & `deleteAfterDate`.

            When updating this field on an existing (non-deleted) cluster, and this is set to zero, then `deleteAfterDate` is reset to null (disable auto deletion) regardless of previous configurations.

            When updating this field on an existing (non-deleted) cluster, and this is set to a positive value, then `createDate` + `deleteAfterCreationHours` must be later than now else the field update is ignored and existing values are preserved for this & `deleteAfterDate`.
          format: int32
          type: integer
        deleteAfterDate:
          description: |-
            The date at which this cluster will be automatically deleted.

            This parameter expresses its value in the ISO 8601 timestamp format in UTC and is derived based on the `createDate` + `deleteAfterCreationHours`.
          format: date-time
          readOnly: true
          type: string
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value is not configurable
            on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you
            set `replicationSpecs`.\n\n If you specify a disk size below the minimum
            (10 GB), this parameter defaults to the minimum disk size value. \n\n
            Storage charge calculations depend on whether you choose the default value
            or a custom value.\n\n The maximum value for disk storage cannot exceed
            50 times the maximum RAM for the selected cluster. If you require more
            storage space, consider upgrading your cluster to a higher tier."
          format: double
          maximum: 4096
          minimum: 10
          type: number
        diskWarmingMode:
          default: FULLY_WARMED
          description: Disk warming mode selection.
          enum:
          - FULLY_WARMED
          - VISIBLE_EARLIER
          externalDocs:
            description: Reduce Secondary Disk Warming Impact
            url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact
          type: string
        encryptionAtRestProvider:
          description: 'Cloud service provider that manages your customer keys to
            provide an additional layer of encryption at rest for the cluster. To
            enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize`
            setting must be `M10` or higher and `"backupEnabled" : false` or omitted
            entirely.'
          enum:
          - NONE
          - AWS
          - AZURE
          - GCP
          externalDocs:
            description: Encryption at Rest using Customer Key Management
            url: https://www.mongodb.com/docs/atlas/security-kms-encryption/
          type: string
        featureCompatibilityVersion:
          description: Feature compatibility version of the cluster.
          readOnly: true
          type: string
        featureCompatibilityVersionExpirationDate:
          description: Feature compatibility version expiration date. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        globalClusterSelfManagedSharding:
          description: |-
            Set this field to configure the Sharding Management Mode when creating a new Global Cluster.

            When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.

            When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.

            This setting cannot be changed once the cluster is deployed.
          externalDocs:
            description: Creating a Global Cluster
            url: https://dochub.mongodb.org/core/global-cluster-management
          type: boolean
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        labels:
          deprecated: true
          description: |-
            Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

            Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ComponentLabel"
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBEmployeeAccessGrant:
          "$ref": "#/components/schemas/EmployeeAccessGrantView"
        mongoDBMajorVersion:
          description: |-
            MongoDB major version of the cluster.

            On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).

             On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
          example: '5.0'
          externalDocs:
            description: Available MongoDB Versions in Atlas
            url: https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-
          type: string
        mongoDBVersion:
          description: Version of MongoDB that the cluster runs.
          example: 5.0.25
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          type: string
        mongoURI:
          description: Base connection string that you can use to connect to the cluster.
            MongoDB Cloud displays the string only after the cluster starts, not while
            it builds the cluster.
          externalDocs:
            description: Connection string URI format.
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        mongoURIUpdated:
          description: Date and time when someone last updated the connection string.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        mongoURIWithOptions:
          description: Connection string that you can use to connect to the cluster
            including the `replicaSet`, `ssl`, and `authSource` query parameters with
            values appropriate for the cluster. You may need to add MongoDB database
            users. The response returns this parameter once the cluster can receive
            requests, not while it builds the cluster.
          externalDocs:
            description: Connection string URI format.
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the cluster.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        numShards:
          default: 1
          description: Number of shards up to 50 to deploy for a sharded cluster.
            The resource returns `1` to indicate a replica set and values of `2` and
            higher to indicate a sharded cluster. The returned value equals the number
            of shards in the cluster.
          externalDocs:
            description: Sharding
            url: https://docs.mongodb.com/manual/sharding/
          format: int32
          maximum: 50
          minimum: 1
          type: integer
        paused:
          description: Flag that indicates whether the cluster is paused.
          type: boolean
        pitEnabled:
          description: Flag that indicates whether the cluster uses continuous cloud
            backups.
          externalDocs:
            description: Continuous Cloud Backups
            url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/
          type: boolean
        providerBackupEnabled:
          description: Flag that indicates whether the M10 or higher cluster can perform
            Cloud Backups. If set to `true`, the cluster can perform backups. If this
            and `backupEnabled` are set to `false`, the cluster doesn't use MongoDB
            Cloud backups.
          type: boolean
        providerSettings:
          "$ref": "#/components/schemas/ClusterProviderSettings"
        replicaSetScalingStrategy:
          default: WORKLOAD_TYPE
          description: |-
            Set this field to configure the replica set scaling mode for your cluster.

            By default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.

            When configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.

            When configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
          enum:
          - SEQUENTIAL
          - WORKLOAD_TYPE
          - NODE_TYPE
          externalDocs:
            description: Modify the Replica Set Scaling Mode
            url: https://dochub.mongodb.org/core/scale-nodes
          type: string
        replicationFactor:
          default: 3
          deprecated: true
          description: Number of members that belong to the replica set. Each member
            retains a copy of your databases, providing high availability and data
            redundancy. Use `replicationSpecs` instead.
          enum:
          - 3
          - 5
          - 7
          format: int32
          type: integer
        replicationSpec:
          additionalProperties:
            "$ref": "#/components/schemas/RegionSpec"
          description: Physical location where MongoDB Cloud provisions cluster nodes.
          title: Region Configuration
          type: object
        replicationSpecs:
          description: |-
            List of settings that configure your cluster regions.

            - For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
            - For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
          items:
            "$ref": "#/components/schemas/LegacyReplicationSpec"
          type: array
        rootCertType:
          default: ISRGROOTX1
          description: Root Certificate Authority that MongoDB Atlas cluster uses.
            MongoDB Cloud supports Internet Security Research Group.
          enum:
          - ISRGROOTX1
          type: string
        srvAddress:
          description: Connection string that you can use to connect to the cluster.
            The `+srv` modifier forces the connection to use Transport Layer Security
            (TLS). The `mongoURI` parameter lists additional options.
          externalDocs:
            description: Connection string URI format.
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
        stateName:
          description: |-
            Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

             - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
             - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
             - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
             - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
             - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the cluster.
          externalDocs:
            description: Resource Tags
            url: https://dochub.mongodb.org/core/add-cluster-tag-atlas
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.
            If set to `false`, MongoDB Cloud will delete the cluster.
          type: boolean
        versionReleaseSystem:
          default: LTS
          description: Method by which the cluster maintains the MongoDB versions.
            If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`.
          enum:
          - LTS
          - CONTINUOUS
          type: string
      required:
      - name
      title: Tenant Cluster Upgrade Request
      type: object
    LegacyReplicationSpec:
      properties:
        id:
          description: |-
            Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.

            - If you include existing zones in the request, you must specify this parameter.

            - If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        numShards:
          default: 1
          description: |-
            Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and `clusterType` is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

             If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request.  You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.
          format: int32
          type: integer
        regionsConfig:
          additionalProperties:
            "$ref": "#/components/schemas/RegionSpec"
          description: Physical location where MongoDB Cloud provisions cluster nodes.
          title: Region Configuration
          type: object
        zoneName:
          description: Human-readable label that identifies the zone in a Global Cluster.
            Provide this value only if `clusterType` is `GEOSHARDED`.
          type: string
      type: object
    LessThanDaysThresholdView:
      description: Threshold value that triggers an alert.
      properties:
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: int32
          type: integer
        units:
          description: Element used to express the quantity. This can be an element
            of time, storage capacity, and the like.
          enum:
          - DAYS
          type: string
      type: object
    LessThanTimeThreshold:
      description: A Limit that triggers an alert when less than a time period.
      properties:
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: int32
          type: integer
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      title: Less Than Time Threshold
      type: object
    LessThanTimeThresholdAlertConfigViewForNdsGroup:
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/ReplicaSetMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/LessThanTimeThreshold"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      type: object
    Link:
      properties:
        href:
          description: Uniform Resource Locator (URL) that points another API resource
            to which this response has some relationship. This URL often begins with
            `https://cloud.mongodb.com/api/atlas`.
          example: https://cloud.mongodb.com/api/atlas
          type: string
        rel:
          description: Uniform Resource Locator (URL) that defines the semantic relationship
            between this resource and another API resource. This URL often begins
            with `https://cloud.mongodb.com/api/atlas`.
          example: self
          type: string
      type: object
    Link_Atlas:
      properties:
        href:
          description: Uniform Resource Locator (URL) that points another API resource
            to which this response has some relationship. This URL often begins with
            `https://cloud.mongodb.com/api/atlas`.
          example: https://cloud.mongodb.com/api/atlas
          type: string
        rel:
          description: Uniform Resource Locator (URL) that defines the semantic relationship
            between this resource and another API resource. This URL often begins
            with `https://cloud.mongodb.com/api/atlas`.
          example: self
          type: string
      type: object
    LiveImportAvailableProject:
      properties:
        deployments:
          description: List of clusters that can be migrated to MongoDB Cloud.
          items:
            "$ref": "#/components/schemas/AvailableClustersDeployment"
          type: array
        migrationHosts:
          description: Hostname of MongoDB Agent list that you configured to perform
            a migration.
          items:
            description: Hostname of MongoDB Agent that you configured to perform
              a migration.
            type: string
          type: array
        name:
          description: Human-readable label that identifies this project.
          maxLength: 64
          minLength: 1
          readOnly: true
          type: string
        projectId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to be migrated.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      required:
      - deployments
      - migrationHosts
      - name
      - projectId
      type: object
    LiveImportValidation:
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the validation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        errorMessage:
          description: Reason why the validation job failed.
          nullable: true
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to validate.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        sourceGroupId:
          description: Unique 24-hexadecimal digit string that identifies the source
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        status:
          description: State of the specified validation job returned at the time
            of the request.
          enum:
          - PENDING
          - SUCCESS
          - FAILED
          nullable: true
          readOnly: true
          type: string
      type: object
    LiveMigrationRequest20240530:
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the migration
            request.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        destination:
          "$ref": "#/components/schemas/Destination"
        dropDestinationData:
          default: false
          description: Flag that indicates whether the migration process drops all
            collections from the destination cluster before the migration starts.
          type: boolean
          writeOnly: true
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        migrationHosts:
          description: List of migration hosts used for this migration.
          items:
            example: vm001.example.com
            minLength: 1
            type: string
          maxItems: 1
          minItems: 1
          type: array
        sharding:
          "$ref": "#/components/schemas/ShardingRequest"
        source:
          "$ref": "#/components/schemas/Source"
      required:
      - destination
      - migrationHosts
      - source
      type: object
    LiveMigrationResponse:
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the migration
            job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lagTimeSeconds:
          description: Replication lag between the source and destination clusters.
            Atlas returns this setting only during an active migration, before the
            cutover phase.
          format: int64
          nullable: true
          readOnly: true
          type: integer
        migrationHosts:
          description: List of hosts running MongoDB Agents. These Agents can transfer
            your MongoDB data between one source and one destination cluster.
          items:
            description: One host running a MongoDB Agent. This Agent can transfer
              your MongoDB data between one source and one destination cluster.
            example: vm001.example.com
            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]+)?$"
            type: string
          readOnly: true
          type: array
        readyForCutover:
          description: Flag that indicates the migrated cluster can be cut over to
            MongoDB Atlas.
          readOnly: true
          type: boolean
        status:
          description: |-
            Progress made in migrating one cluster to MongoDB Atlas.

            `NEW`: Someone scheduled a local cluster migration to MongoDB Atlas.

            `FAILED`: The cluster migration to MongoDB Atlas failed.

            `COMPLETE`: The cluster migration to MongoDB Atlas succeeded.

            `EXPIRED`: MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `"readyForCutover" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status.

            `WORKING`: The cluster migration to MongoDB Atlas is performing one of the following tasks:

            - Preparing connections to source and destination clusters.
            - Replicating data from source to destination.
            - Verifying MongoDB Atlas connection settings.
            - Stopping replication after the cut over.
          enum:
          - NEW
          - WORKING
          - FAILED
          - COMPLETE
          - EXPIRED
          readOnly: true
          type: string
      type: object
    LogIntegrationRequest:
      description: Request schema for creating or updating a log integration.
      discriminator:
        mapping:
          AZURE_LOG_EXPORT: "#/components/schemas/AzureLogIntegrationRequest"
          DATADOG_LOG_EXPORT: "#/components/schemas/DatadogLogIntegrationRequest"
          GCS_LOG_EXPORT: "#/components/schemas/GcsLogIntegrationRequest"
          OTEL_LOG_EXPORT: "#/components/schemas/OtelLogIntegrationRequest"
          S3_LOG_EXPORT: "#/components/schemas/S3LogIntegrationRequest"
          SPLUNK_LOG_EXPORT: "#/components/schemas/SplunkLogIntegrationRequest"
        propertyName: type
      oneOf:
      - "$ref": "#/components/schemas/S3LogIntegrationRequest"
      - "$ref": "#/components/schemas/DatadogLogIntegrationRequest"
      - "$ref": "#/components/schemas/GcsLogIntegrationRequest"
      - "$ref": "#/components/schemas/OtelLogIntegrationRequest"
      - "$ref": "#/components/schemas/SplunkLogIntegrationRequest"
      - "$ref": "#/components/schemas/AzureLogIntegrationRequest"
      properties:
        logTypes:
          description: Array of log types exported by this integration.
          example:
          - MONGOD
          - MONGOS
          items:
            enum:
            - MONGOD
            - MONGOS
            - MONGOD_AUDIT
            - MONGOS_AUDIT
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
        type:
          description: Type of log integration. Identifies which service will receive
            the exported logs. This value cannot be modified after the integration
            is created.
          enum:
          - S3_LOG_EXPORT
          - DATADOG_LOG_EXPORT
          - GCS_LOG_EXPORT
          - OTEL_LOG_EXPORT
          - SPLUNK_LOG_EXPORT
          - AZURE_LOG_EXPORT
          type: string
      required:
      - logTypes
      - type
      title: Log Export Integration Request
      type: object
    LogIntegrationResponse:
      description: Response schema for log integration operations.
      discriminator:
        mapping:
          AZURE_LOG_EXPORT: "#/components/schemas/AzureLogIntegrationResponse"
          DATADOG_LOG_EXPORT: "#/components/schemas/DatadogLogIntegrationResponse"
          GCS_LOG_EXPORT: "#/components/schemas/GcsLogIntegrationResponse"
          OTEL_LOG_EXPORT: "#/components/schemas/OtelLogIntegrationResponse"
          S3_LOG_EXPORT: "#/components/schemas/S3LogIntegrationResponse"
          SPLUNK_LOG_EXPORT: "#/components/schemas/SplunkLogIntegrationResponse"
        propertyName: type
      oneOf:
      - "$ref": "#/components/schemas/S3LogIntegrationResponse"
      - "$ref": "#/components/schemas/DatadogLogIntegrationResponse"
      - "$ref": "#/components/schemas/GcsLogIntegrationResponse"
      - "$ref": "#/components/schemas/OtelLogIntegrationResponse"
      - "$ref": "#/components/schemas/SplunkLogIntegrationResponse"
      - "$ref": "#/components/schemas/AzureLogIntegrationResponse"
      properties:
        id:
          description: Unique 24-character hexadecimal digit string that identifies
            the log integration configuration.
          example: 507f1f77bcf86cd799439011
          type: string
        logTypes:
          description: Array of log types exported by this integration.
          example:
          - MONGOD
          - MONGOS
          items:
            enum:
            - MONGOD
            - MONGOS
            - MONGOD_AUDIT
            - MONGOS_AUDIT
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
        type:
          description: Type of log integration. Identifies which service will receive
            the exported logs. This value cannot be modified after the integration
            is created.
          enum:
          - S3_LOG_EXPORT
          - DATADOG_LOG_EXPORT
          - GCS_LOG_EXPORT
          - OTEL_LOG_EXPORT
          - SPLUNK_LOG_EXPORT
          - AZURE_LOG_EXPORT
          type: string
      required:
      - id
      - logTypes
      - type
      title: Log Integration Response
      type: object
    LogicalSizeDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    ManagedNamespaces:
      properties:
        collection:
          description: Human-readable label of the collection to manage for this Global
            Cluster.
          type: string
        customShardKey:
          description: Database parameter used to divide the *collection* into shards.
            Global clusters require a compound shard key. This compound shard key
            combines the location parameter and the user-selected custom key.
          type: string
        db:
          description: Human-readable label of the database to manage for this Global
            Cluster.
          type: string
        isCustomShardKeyHashed:
          default: false
          description: Flag that indicates whether someone hashed the custom shard
            key for the specified collection. If you set this value to `false`, MongoDB
            Cloud uses ranged sharding.
          externalDocs:
            description: Hashed Shard Keys
            url: https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys
          type: boolean
        isShardKeyUnique:
          default: false
          description: Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys)
            the custom shard key. If this parameter returns `false`, this cluster
            uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).
          type: boolean
        numInitialChunks:
          description: Minimum number of chunks to create initially when sharding
            an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).
          externalDocs:
            description: Global Cluster Sharding
            url: https://www.mongodb.com/docs/atlas/shard-global-collection/
          format: int64
          maximum: 8192
          type: integer
        presplitHashedZones:
          default: false
          description: Flag that indicates whether MongoDB Cloud should create and
            distribute initial chunks for an empty or non-existing collection. MongoDB
            Cloud distributes data based on the defined zones and zone ranges for
            the collection.
          externalDocs:
            description: Hashed Shard Key
            url: https://www.mongodb.com/docs/manual/core/hashed-sharding/
          type: boolean
      required:
      - collection
      - customShardKey
      - db
      type: object
    MatcherFieldView:
      oneOf:
      - enum:
        - APPLICATION_ID
        title: App Services Metric Matcher Fields
        type: string
      - enum:
        - CLUSTER_NAME
        title: Cluster Matcher Fields
        type: string
      - enum:
        - TYPE_NAME
        - HOSTNAME
        - PORT
        - HOSTNAME_AND_PORT
        - REPLICA_SET_NAME
        - ATLAS_NODE_TYPE
        title: Host Matcher Fields
        type: string
      - enum:
        - REPLICA_SET_NAME
        - SHARD_NAME
        - CLUSTER_NAME
        title: Replica Set Matcher Fields
        type: string
      - enum:
        - INSTANCE_NAME
        - PROCESSOR_NAME
        title: Streams Matcher Fields
        type: string
      - enum:
        - RULE_ID
        title: Log Ingestion Matcher Fields
        type: string
      - enum:
        - SOFTWARE_TYPE
        title: Global Software Type Matcher Fields
        type: string
      type: object
    MatcherHostType:
      description: Value to match or exceed using the specified `matchers.operator`.
      enum:
      - STANDALONE
      - PRIMARY
      - SECONDARY
      - ARBITER
      - MONGOS
      - CONFIG
      - MONGOT
      example: STANDALONE
      title: Matcher Host Types
      type: string
    MaxDiskPartitionQueueDepthDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionQueueDepthIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionQueueDepthJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionReadIopsDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionReadIopsIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionReadIopsJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionReadLatencyDataTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionSpaceUsedDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionWriteIopsDataRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionWriteIopsIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionWriteIopsJournalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    MaxNormalizedSystemCpuStealRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxNormalizedSystemCpuUserRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxSwapUsageFreeDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MaxSwapUsageUsedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MaxSystemMemoryAvailableDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MaxSystemMemoryPercentUsedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MaxSystemMemoryUsedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MaxSystemNetworkInDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MaxSystemNetworkOutDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MdbAvailableVersion:
      properties:
        cloudProvider:
          description: Cloud service provider on which MongoDB Cloud provisions the
            hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.
          enum:
          - AWS
          - AZURE
          - GCP
          - TENANT
          type: string
        defaultStatus:
          description: Whether the version is the current default for the Instance
            Size and Cloud Provider.
          enum:
          - DEFAULT
          - NOT_DEFAULT
          type: string
        instanceSize:
          "$ref": "#/components/schemas/BaseCloudProviderInstanceSize"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        version:
          description: The MongoDB Major Version in question.
          externalDocs:
            description: MongoDB Versioning
            url: https://www.mongodb.com/docs/manual/reference/versioning/
          type: string
      type: object
    MeasurementDiskPartition:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        partitionName:
          description: Human-readable label of the disk or partition to which the
            measurements apply.
          readOnly: true
          type: string
      type: object
    MeasurementsCollStatsLatencyCluster:
      properties:
        clusterId:
          description: Unique identifier for Clusters.
          readOnly: true
          type: string
        clusterView:
          description: Cluster topology view.
          readOnly: true
          type: string
        collectionName:
          description: Human-readable label that identifies the collection.
          readOnly: true
          type: string
        databaseName:
          description: Human-readable label that identifies the database that the
            specified MongoDB process serves.
          readOnly: true
          type: string
        end:
          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.
          format: date-time
          readOnly: true
          type: string
        granularity:
          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
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        measurements:
          description: List that contains measurements and their data points.
          items:
            "$ref": "#/components/schemas/MetricsMeasurement"
          readOnly: true
          type: array
        processId:
          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
          type: string
        start:
          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.
          format: date-time
          readOnly: true
          type: string
      type: object
    MeasurementsCollStatsLatencyHost:
      properties:
        collectionName:
          description: Human-readable label that identifies the collection.
          readOnly: true
          type: string
        databaseName:
          description: Human-readable label that identifies the database that the
            specified MongoDB process serves.
          readOnly: true
          type: string
        end:
          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.
          format: date-time
          readOnly: true
          type: string
        granularity:
          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
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        measurements:
          description: List that contains measurements and their data points.
          items:
            "$ref": "#/components/schemas/MetricsMeasurement"
          readOnly: true
          type: array
        processId:
          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
          type: string
        start:
          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.
          format: date-time
          readOnly: true
          type: string
      type: object
    MeasurementsIndexes:
      properties:
        collectionName:
          description: Human-readable label that identifies the collection.
          readOnly: true
          type: string
        databaseName:
          description: Human-readable label that identifies the database that the
            specified MongoDB process serves.
          readOnly: true
          type: string
        end:
          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.
          format: date-time
          readOnly: true
          type: string
        granularity:
          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
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        indexIds:
          description: List that contains the Atlas Search index identifiers.
          items:
            description: Unique 24-hexadecimal digit string that identifies the index.
            type: string
          readOnly: true
          type: array
        indexStatsMeasurements:
          description: List that contains the Atlas Search index stats measurements.
          items:
            "$ref": "#/components/schemas/MetricsMeasurement"
          readOnly: true
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        processId:
          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
          type: string
        start:
          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.
          format: date-time
          readOnly: true
          type: string
      type: object
    MeasurementsNonIndex:
      properties:
        end:
          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.
          format: date-time
          readOnly: true
          type: string
        granularity:
          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
          type: string
        groupId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hardwareMeasurements:
          description: List that contains the Atlas Search hardware measurements.
          items:
            "$ref": "#/components/schemas/MetricsMeasurement"
          readOnly: true
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        processId:
          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
          type: string
        start:
          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.
          format: date-time
          readOnly: true
          type: string
        statusMeasurements:
          description: List that contains the Atlas Search status measurements.
          items:
            "$ref": "#/components/schemas/MetricsMeasurement"
          readOnly: true
          type: array
      type: object
    MemoryMappedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MemoryResidentDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MemoryVirtualDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    MesurementsDatabase:
      properties:
        databaseName:
          description: Human-readable label that identifies the database that the
            specified MongoDB process serves.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    MetricDataPoint:
      description: Value of, and metadata provided for, one data point generated at
        a particular moment in time. If no data point exists for a particular moment
        in time, the `value` parameter returns `null`.
      properties:
        timestamp:
          description: Date and time when this data point occurred. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        value:
          description: Value that comprises this data point.
          readOnly: true
          type: number
      readOnly: true
      type: object
    MetricDataPoint_Atlas:
      description: Value of, and metadata provided for, one data point generated at
        a particular moment in time. If no data point exists for a particular moment
        in time, the `value` parameter returns `null`.
      properties:
        timestamp:
          description: Date and time when this data point occurred. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        value:
          description: Value that comprises this data point.
          readOnly: true
          type: number
      readOnly: true
      type: object
    MetricsMeasurement:
      properties:
        dataPoints:
          description: List that contains the value of, and metadata provided for,
            one data point generated at a particular moment in time. If no data point
            exists for a particular moment in time, the `value` parameter returns
            `null`.
          items:
            "$ref": "#/components/schemas/MetricDataPoint"
          readOnly: true
          type: array
        name:
          description: Human-readable label of the measurement that this data point
            covers.
          readOnly: true
          type: string
        units:
          description: Element used to quantify the measurement. The resource returns
            units of throughput, storage, and time.
          enum:
          - BYTES
          - BYTES_PER_SECOND
          - GIGABYTES
          - GIGABYTES_PER_HOUR
          - MEGABYTES_PER_SECOND
          - MICROSECONDS
          - MILLISECONDS
          - PERCENT
          - SCALAR
          - SCALAR_PER_SECOND
          readOnly: true
          type: string
      type: object
    MetricsMeasurement_Atlas:
      properties:
        dataPoints:
          description: List that contains the value of, and metadata provided for,
            one data point generated at a particular moment in time. If no data point
            exists for a particular moment in time, the `value` parameter returns
            `null`.
          items:
            "$ref": "#/components/schemas/MetricDataPoint_Atlas"
          readOnly: true
          type: array
        name:
          description: Human-readable label of the measurement that this data point
            covers.
          readOnly: true
          type: string
        units:
          description: Element used to quantify the measurement. The resource returns
            units of throughput, storage, and time.
          enum:
          - BYTES
          - BYTES_PER_SECOND
          - GIGABYTES
          - GIGABYTES_PER_HOUR
          - MEGABYTES_PER_SECOND
          - MICROSECONDS
          - MILLISECONDS
          - PERCENT
          - SCALAR
          - SCALAR_PER_SECOND
          readOnly: true
          type: string
      type: object
    MicrosoftTeams:
      description: Details to integrate one Microsoft Teams account with one MongoDB
        Cloud project.
      properties:
        id:
          description: Integration id.
          nullable: true
          type: string
        microsoftTeamsWebhookUrl:
          description: |-
            Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.

            **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
          example: https://webhook.com/****
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - MICROSOFT_TEAMS
          type: string
      required:
      - microsoftTeamsWebhookUrl
      title: MICROSOFT_TEAMS
      type: object
    MicrosoftTeamsNotification:
      description: Microsoft Teams notification configuration for MongoDB Cloud to
        send information when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        microsoftTeamsWebhookUrl:
          description: |-
            Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `"notifications.[n].typeName" : "MICROSOFT_TEAMS"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.

            **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
          example: https://webhook.com/****
          type: string
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - MICROSOFT_TEAMS
          type: string
      required:
      - typeName
      title: Microsoft Teams Notification
      type: object
    MongoDBAccessLogs:
      description: Authentication attempt, one per object, made against the cluster.
      properties:
        authResult:
          description: Flag that indicates whether the response should return successful
            authentication attempts only.
          type: boolean
        authSource:
          description: Database against which someone attempted to authenticate.
          readOnly: true
          type: string
        failureReason:
          description: Reason that the authentication failed. Null if authentication
            succeeded.
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          readOnly: true
          type: string
        hostname:
          description: Human-readable label that identifies the hostname of the target
            node that received the authentication attempt.
          readOnly: true
          type: string
        ipAddress:
          description: Internet Protocol address that attempted to authenticate with
            the database.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          readOnly: true
          type: string
        logLine:
          description: Text of the host log concerning the authentication attempt.
          readOnly: true
          type: string
        timestamp:
          description: Date and time when someone made this authentication attempt.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          readOnly: true
          type: string
        username:
          description: Username used to authenticate against the database.
          readOnly: true
          type: string
      type: object
    MongoDBAccessLogsList:
      properties:
        accessLogs:
          description: Authentication attempt, one per object, made against the cluster.
          items:
            "$ref": "#/components/schemas/MongoDBAccessLogs"
          readOnly: true
          type: array
      type: object
    MongotuneAlertConfigViewForNdsGroup:
      description: Intelligent Workload Management alert configuration allows to select
        which Intelligent Workload Management events trigger alerts and how users
        are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/MongotuneEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Intelligent Workload Management Alert Configuration
      type: object
    MongotuneEventTypeViewAlertable:
      description: Event type that triggers an alert.
      enum:
      - MONGOTUNE_ALERT
      example: MONGOTUNE_ALERT
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Mongotune Event Types
      type: string
    MonthlyScheduleView:
      allOf:
      - "$ref": "#/components/schemas/OnlineArchiveSchedule"
      - properties:
          dayOfMonth:
            description: Day of the month when the scheduled archive starts.
            format: int32
            maximum: 31
            minimum: 1
            type: integer
          endHour:
            description: Hour of the day when the scheduled window to run one online
              archive ends. This field uses the UTC time zone. The window must have
              a duration of at least two hours. If the end time is before or equal
              to the start time, the window extends to the next day.
            format: int32
            maximum: 23
            minimum: 0
            type: integer
          endMinute:
            description: Minute of the hour when the scheduled window to run one online
              archive ends. This field uses the UTC time zone. The window must have
              a duration of at least two hours. If the end time is before or equal
              to the start time, the window extends to the next day.
            format: int32
            maximum: 59
            minimum: 0
            type: integer
          startHour:
            description: Hour of the day when the scheduled window to run one online
              archive starts. This field uses the UTC time zone.
            format: int32
            maximum: 23
            minimum: 0
            type: integer
          startMinute:
            description: Minute of the hour when the scheduled window to run one online
              archive starts. This field uses the UTC time zone.
            format: int32
            maximum: 59
            minimum: 0
            type: integer
        type: object
      required:
      - type
      type: object
    MuninCpuIowaitRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MuninCpuIrqRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MuninCpuNiceRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MuninCpuSoftirqRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MuninCpuStealRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MuninCpuSystemRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    MuninCpuUserRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    NDSAuditTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - CLUSTER_CREATED
      - CLUSTER_RESURRECTED
      - CLUSTER_READY
      - CLUSTER_UPDATE_SUBMITTED
      - CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED
      - CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED
      - CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED
      - CLUSTER_AUTOMATICALLY_PAUSED
      - CLUSTER_UPDATE_STARTED
      - CLUSTER_UPDATE_STARTED_INTERNAL
      - CLUSTER_UPDATE_COMPLETED
      - MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL
      - CLUSTER_DELETE_SUBMITTED
      - CLUSTER_DELETE_SUBMITTED_INTERNAL
      - CLUSTER_DELETED
      - CLUSTER_IMPORT_STARTED
      - CLUSTER_IMPORT_CANCELLED
      - CLUSTER_IMPORT_EXPIRED
      - CLUSTER_IMPORT_CUTOVER
      - CLUSTER_IMPORT_COMPLETED
      - CLUSTER_IMPORT_FAILED
      - CLUSTER_IMPORT_RESTART_REQUESTED
      - PROJECT_LIVE_IMPORT_OVERRIDES_ADDED
      - PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED
      - PROJECT_LIVE_IMPORT_OVERRIDES_DELETED
      - CLUSTER_OPLOG_RESIZED
      - CLUSTER_INSTANCE_RESTARTED
      - CLUSTER_INSTANCE_STOP_START
      - CLUSTER_INSTANCE_RESYNC_REQUESTED
      - CLUSTER_INSTANCE_RESYNC_CLEARED
      - CLUSTER_INSTANCE_UPDATE_REQUESTED
      - CLUSTER_INSTANCE_REPLACED
      - CLUSTER_INSTANCE_REPLACE_CLEARED
      - CLUSTER_INSTANCE_SWAPPED
      - CLUSTER_INSTANCE_SWAP_CLEARED
      - CLUSTER_INSTANCE_VM_RESTART_CLEARED
      - CLUSTER_INSTANCE_VM_REBOOT_CLEARED
      - CLUSTER_INSTANCE_CONFIG_UPDATED
      - CLUSTER_INSTANCE_AGENT_API_KEY_ROTATED
      - CLUSTER_INSTANCE_SSL_ROTATED
      - CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER
      - CLUSTER_INSTANCE_SSL_REVOKED
      - RELOAD_SSL_ON_PROCESSES
      - RELOAD_SSL_ON_PROCESSES_REQUESTED
      - CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED
      - DATA_LAKE_QUERY_LOGS_DOWNLOADED
      - FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED
      - ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED
      - MONGODB_LOGS_DOWNLOADED
      - MONGOSQLD_LOGS_DOWNLOADED
      - MONGOT_LOGS_DOWNLOADED
      - MONGODB_USER_ADDED
      - MONGODB_USER_DELETED
      - MONGODB_USER_X509_CERT_CREATED
      - MONGODB_USER_X509_CERT_REVOKED
      - MONGODB_USER_UPDATED
      - MONGODB_ROLE_ADDED
      - MONGODB_ROLE_DELETED
      - MONGODB_ROLE_UPDATED
      - NETWORK_PERMISSION_ENTRY_ADDED
      - NETWORK_PERMISSION_ENTRY_REMOVED
      - NETWORK_PERMISSION_ENTRY_UPDATED
      - PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED
      - PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED
      - PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED
      - PLAN_STARTED
      - PLAN_COMPLETED
      - PLAN_ABANDONED
      - PLAN_DECLINED
      - PLAN_FAILURE_COUNT_RESET
      - PLAN_ASAP_REQUESTED
      - INDEPENDENT_SHARD_AUTO_SCALING_AVAILABLE
      - INDEPENDENT_SHARD_SCALING_CLUSTER_MIGRATED
      - INDEPENDENT_SHARD_SCALING_CLUSTER_ROLLED_BACK
      - MOVE_SKIPPED
      - STEP_SKIPPED
      - PROXY_RESTARTED
      - PROXY_PANICKED
      - ATLAS_MAINTENANCE_PROTECTED_HOURS_CREATED
      - ATLAS_MAINTENANCE_PROTECTED_HOURS_MODIFIED
      - ATLAS_MAINTENANCE_PROTECTED_HOURS_REMOVED
      - ATLAS_MAINTENANCE_WINDOW_ADDED
      - ATLAS_MAINTENANCE_WINDOW_MODIFIED
      - ATLAS_MAINTENANCE_WINDOW_REMOVED
      - ATLAS_MAINTENANCE_START_ASAP
      - ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW
      - ATLAS_MAINTENANCE_DEFERRED
      - ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED
      - ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED
      - ATLAS_MAINTENANCE_RESET_BY_ADMIN
      - ATLAS_MAINTENANCE_DEFERRED_BY_ADMIN
      - SCHEDULED_MAINTENANCE
      - PROJECT_SCHEDULED_MAINTENANCE
      - PROJECT_LIMIT_UPDATED
      - PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED
      - OS_MAINTENANCE
      - OS_MAINTENANCE_RESTART
      - OS_MAINTENANCE_REPLACEMENT
      - FREE_UPGRADE_STARTED
      - FLEX_UPGRADE_STARTED
      - SERVERLESS_UPGRADE_STARTED
      - TEST_FAILOVER_REQUESTED
      - USER_SECURITY_SETTINGS_UPDATED
      - AUDIT_LOG_CONFIGURATION_UPDATED
      - STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED
      - ENCRYPTION_AT_REST_CONFIGURATION_UPDATED
      - ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED
      - ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_SUCCEEDED
      - ENCRYPTION_AT_REST_KEY_ROTATION_STARTED
      - ENCRYPTION_AT_REST_PRIVATE_ENDPOINT_CREATED
      - ENCRYPTION_AT_REST_PRIVATE_ENDPOINT_DELETED
      - NDS_SET_IMAGE_OVERRIDES
      - NDS_SET_CHEF_TARBALL_URI
      - RESTRICTED_EMPLOYEE_ACCESS_BYPASS
      - REVOKED_EMPLOYEE_ACCESS_BYPASS
      - DEVICE_SYNC_DEBUG_ACCESS_GRANTED
      - DEVICE_SYNC_DEBUG_ACCESS_REVOKED
      - DEVICE_SYNC_DEBUG_X509_CERT_CREATED
      - EMPLOYEE_ACCESS_GRANTED
      - EMPLOYEE_ACCESS_REVOKED
      - QUERY_ENGINE_TENANT_CREATED
      - QUERY_ENGINE_TENANT_UPDATED
      - QUERY_ENGINE_TENANT_REMOVED
      - FEDERATED_DATABASE_CREATED
      - FEDERATED_DATABASE_UPDATED
      - FEDERATED_DATABASE_REMOVED
      - TENANT_SNAPSHOT_FAILED
      - TENANT_RESTORE_FAILED
      - SAMPLE_DATASET_LOAD_REQUESTED
      - CUSTOMER_X509_CRL_UPDATED
      - CONTAINER_SUBNETS_UPDATE_REQUESTED
      - ONLINE_ARCHIVE_CREATED
      - ONLINE_ARCHIVE_DELETED
      - ONLINE_ARCHIVE_UPDATED
      - ONLINE_ARCHIVE_PAUSE_REQUESTED
      - ONLINE_ARCHIVE_PAUSED
      - ONLINE_ARCHIVE_ACTIVE
      - ONLINE_ARCHIVE_ORPHANED
      - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED
      - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED
      - ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED
      - ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED
      - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED
      - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED
      - CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED
      - CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED
      - CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED
      - CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED
      - CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_ADDED
      - CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_DELETED
      - CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_UPDATED
      - PENDING_INDEXES_DELETED
      - PENDING_INDEXES_CANCELED
      - PROCESS_RESTART_REQUESTED
      - AUTO_HEALING_ACTION
      - AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE
      - AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT
      - AUTO_HEALING_REQUESTED_NODE_RESYNC
      - EXTRA_MAINTENANCE_DEFERRAL_GRANTED
      - GROUP_AUTOMATION_CONFIG_PUBLISHED
      - CLUSTER_AUTOMATION_CONFIG_PUBLISHED
      - SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER
      - CLUSTER_LINKED_TO_VERCEL
      - CLUSTER_UNLINKED_FROM_VERCEL
      - INGESTION_PIPELINE_DELETED
      - INGESTION_PIPELINE_DESTROYED
      - INGESTION_PIPELINE_CREATED
      - INGESTION_PIPELINE_UPDATED
      - OS_TUNE_FILE_OVERRIDES
      - MONITORING_AGENT_OVERRIDES
      - MONITORING_AGENT_REBALANCE_FLAG
      - MONITORING_AGENT_REBALANCE_TRIGGERED
      - CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED
      - CLUSTER_FORCE_PLANNED
      - CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED
      - CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START
      - CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED
      - CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED
      - CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE
      - UIS_PANICKED
      - TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL
      - TENANT_UPGRADE_TO_SERVERLESS_FAILED
      - SERVERLESS_UPGRADE_TO_DEDICATED_SUCCESSFUL
      - SERVERLESS_UPGRADE_TO_DEDICATED_FAILED
      - CLUSTER_FORCE_RECONFIG_REQUESTED
      - PROJECT_BYPASSED_MAINTENANCE
      - FEATURE_FLAG_MAINTENANCE
      - DATA_FEDERATION_QUERY_LIMIT_CONFIGURED
      - DATA_FEDERATION_QUERY_LIMIT_DELETED
      - DATA_API_SETUP_FOR_VERCEL
      - ADMIN_CLUSTER_LOCK_UPDATED
      - CLUSTER_ROLLING_RESYNC_STARTED
      - CLUSTER_ROLLING_RESYNC_COMPLETED
      - CLUSTER_ROLLING_RESYNC_FAILED
      - NODE_ROLLING_RESYNC_SCHEDULED
      - CLUSTER_ROLLING_RESYNC_CANCELED
      - CLUSTER_OS_UPDATED
      - CLUSTER_INSTANCE_FAMILY_UPDATED
      - PUSH_BASED_LOG_EXPORT_ENABLED
      - PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED
      - PUSH_BASED_LOG_EXPORT_DISABLED
      - LOG_STREAMING_ENABLED
      - LOG_STREAMING_CONFIGURATION_UPDATED
      - LOG_STREAMING_DISABLED
      - DATADOG_LOG_STREAMING_ENABLED
      - DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED
      - DATADOG_LOG_STREAMING_DISABLED
      - SPLUNK_LOG_STREAMING_ENABLED
      - SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED
      - SPLUNK_LOG_STREAMING_DISABLED
      - S3_LOG_STREAMING_ENABLED
      - S3_LOG_STREAMING_CONFIGURATION_UPDATED
      - S3_LOG_STREAMING_DISABLED
      - AZURE_LOG_STREAMING_ENABLED
      - AZURE_LOG_STREAMING_CONFIGURATION_UPDATED
      - AZURE_LOG_STREAMING_DISABLED
      - GCP_LOG_STREAMING_ENABLED
      - GCP_LOG_STREAMING_CONFIGURATION_UPDATED
      - GCP_LOG_STREAMING_DISABLED
      - OTEL_LOG_STREAMING_ENABLED
      - OTEL_LOG_STREAMING_CONFIGURATION_UPDATED
      - OTEL_LOG_STREAMING_DISABLED
      - OTEL_METRIC_INTEGRATION_ENABLED
      - OTEL_METRIC_INTEGRATION_CONFIGURATION_UPDATED
      - OTEL_METRIC_INTEGRATION_DISABLED
      - AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED
      - CONTAINER_DELETED
      - REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED
      - REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED
      - STREAM_TENANT_CREATED
      - STREAM_TENANT_UPDATED
      - STREAM_TENANT_DELETED
      - STREAM_TENANT_CONNECTIONS_LISTED
      - STREAM_TENANT_CONNECTION_UPDATED
      - STREAM_TENANT_CONNECTION_DELETED
      - STREAM_TENANT_CONNECTION_CREATED
      - STREAM_TENANT_CONNECTION_VIEWED
      - STREAM_TENANT_OPERATIONAL_LOGS
      - STREAM_TENANT_AUDIT_LOGS
      - STREAM_TENANT_AUDIT_LOGS_DELETED
      - QUEUED_ADMIN_ACTION_CREATED
      - QUEUED_ADMIN_ACTION_COMPLETED
      - QUEUED_ADMIN_ACTION_CANCELLED
      - ATLAS_SQL_SCHEDULED_UPDATE_CREATED
      - ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED
      - ATLAS_SQL_SCHEDULED_UPDATE_REMOVED
      - CLUSTER_INSTANCE_DISABLED
      - CLUSTER_INSTANCE_ENABLED
      - CLUSTER_BLOCK_WRITE
      - CLUSTER_UNBLOCK_WRITE
      - KMIP_KEY_ROTATION_SCHEDULED
      - SSL_CERTIFICATE_ISSUED
      - PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS
      - CLUSTER_CANCELING_SHARD_DRAIN_REQUESTED
      - CLUSTER_CANCELING_CONFIG_SERVER_TRANSITION_REQUESTED
      - CLUSTER_MIGRATE_BACK_TO_AWS_MANAGED_IP_REQUESTED
      - CLUSTER_IP_MIGRATED_FIRST_ROUND
      - CLUSTER_IP_MIGRATED_SECOND_ROUND
      - CLUSTER_IP_MIGRATED_FINAL_ROUND
      - CLUSTER_IP_ROLLED_BACK
      - AZ_BALANCING_OVERRIDE_MODIFIED
      - FTDC_SETTINGS_UPDATED
      - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED
      - MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE
      - MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE
      - PREDICTIVE_AUTOSCALING_ENABLED
      - PREDICTIVE_AUTOSCALING_DISABLED
      - SHADOW_CLUSTER_CREATE_EXPOSURE
      - SHADOW_CLUSTER_DELETE_EXPOSURE
      - SHADOW_CLUSTER_RECORDING_STATUS_UPDATE
      - SHADOW_CLUSTER_REPLAY_STATUS_UPDATE
      - NODE_HIDDEN_BY_ADMIN
      - NODE_UNHIDDEN_BY_ADMIN
      - CLUSTER_CREATED_VIA_ANIS
      example: CLUSTER_CREATED
      title: Atlas Audit Types
      type: string
    NDSAuditTypeViewForOrg:
      description: Unique identifier of event type.
      enum:
      - ORG_LIMIT_UPDATED
      - SHADOW_CLUSTER_ORG_OPT_IN
      - SHADOW_CLUSTER_ORG_OPT_OUT
      example: ORG_LIMIT_UPDATED
      title: Atlas Audit Types
      type: string
    NDSAuditViewForNdsGroup:
      description: Audit saving information about Atlas cloud provider and other Atlas
        related details.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        dbUserUsername:
          description: The username of the MongoDB User that was created, deleted,
            or edited.
          example: user1
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/NDSAuditTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
        whitelistEntry:
          description: Entry in the list of source host addresses that the API key
            accepts and this event targets.
          example: 0.0.0.0
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Atlas Project Audits
      type: object
    NDSAuditViewForOrg:
      description: Audit saving information about Atlas cloud provider and other Atlas
        related details.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        dbUserUsername:
          description: The username of the MongoDB User that was created, deleted,
            or edited.
          example: user1
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/NDSAuditTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
        whitelistEntry:
          description: Entry in the list of source host addresses that the API key
            accepts and this event targets.
          example: 0.0.0.0
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Atlas Organization Audits
      type: object
    NDSAutoScalingAuditTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - COMPUTE_AUTO_SCALE_INITIATED
      - DISK_AUTO_SCALE_INITIATED
      - COMPUTE_AUTO_SCALE_INITIATED_BASE
      - COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS
      - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE
      - COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS
      - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_BASE
      - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_ANALYTICS
      - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
      - COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS
      - COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
      - COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS
      - DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL
      - DISK_AUTO_SCALE_OPLOG_FAIL
      - PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE
      - PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE
      - PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE
      - CLUSTER_AUTO_SHARDING_INITIATED
      example: COMPUTE_AUTO_SCALE_INITIATED
      title: Auto Scaling Audit Types
      type: string
    NDSAutoScalingAuditViewForNdsGroup:
      description: Auto scaling audit indicates when Atlas auto-scaling cluster tier
        up or down.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Auto Scaling Audits
      type: object
    NDSServerlessInstanceAuditTypeView:
      description: Unique identifier of event type.
      enum:
      - SERVERLESS_INSTANCE_CREATED
      - SERVERLESS_INSTANCE_READY
      - SERVERLESS_INSTANCE_UPDATE_SUBMITTED
      - SERVERLESS_INSTANCE_UPDATE_STARTED
      - SERVERLESS_INSTANCE_UPDATE_COMPLETED
      - SERVERLESS_INSTANCE_DELETE_SUBMITTED
      - SERVERLESS_INSTANCE_DELETED
      - SERVERLESS_INSTANCE_UNBLOCKED
      example: SERVERLESS_INSTANCE_CREATED
      title: Serverless Instance Audit Types
      type: string
    NDSServerlessInstanceAuditView:
      description: Serverless instance audit identifies any activities around serverless
        instance.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/NDSServerlessInstanceAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Serverless Instance Audits
      type: object
    NDSTenantEndpointAuditTypeView:
      description: Unique identifier of event type.
      enum:
      - TENANT_ENDPOINT_CREATED
      - TENANT_ENDPOINT_RESERVED
      - TENANT_ENDPOINT_RESERVATION_FAILED
      - TENANT_ENDPOINT_UPDATED
      - TENANT_ENDPOINT_INITIATING
      - TENANT_ENDPOINT_AVAILABLE
      - TENANT_ENDPOINT_FAILED
      - TENANT_ENDPOINT_DELETING
      - TENANT_ENDPOINT_DELETED
      - TENANT_ENDPOINT_EXPIRED
      example: TENANT_ENDPOINT_CREATED
      title: Auto Scaling Audit Types
      type: string
    NDSTenantEndpointAuditView:
      description: Tenant endpoint audit indicates when Atlas auto-scaling cluster
        tier up or down.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        endpointId:
          description: Unique 24-hexadecimal digit string that identifies the endpoint
            associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/NDSTenantEndpointAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        providerEndpointId:
          description: Unique identification string that the cloud provider uses to
            identify the private endpoint.
          example: vpce-0d6c248dedef65a25
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Tenant Endpoint Audits
      type: object
    NDSX509UserAuthenticationAlertConfigViewForNdsGroup:
      description: X509 User Authentication alert configuration allows to select thresholds
        for expiration of client, CA certificates and CRL which trigger alerts and
        how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/LessThanDaysThresholdView"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: X509 User Authentication Alert Configuration
      type: object
    NDSX509UserAuthenticationEventTypeViewAlertable:
      description: Event type that triggers an alert.
      enum:
      - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK
      - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK
      - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK
      example: NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: x509 User Auth Event Types
      type: string
    NamespaceObj:
      description: Human-readable label that identifies the namespace on the specified
        host. The resource expresses this parameter value as `<database>.<collection>`.
      properties:
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          readOnly: true
          type: string
        type:
          default: collection
          description: Human-readable label that identifies the type of namespace.
          enum:
          - collection
          readOnly: true
          type: string
      readOnly: true
      type: object
    Namespaces:
      properties:
        namespaces:
          description: List that contains each combination of database, collection,
            and type on the specified host.
          items:
            "$ref": "#/components/schemas/NamespaceObj"
          readOnly: true
          type: array
          uniqueItems: true
      type: object
    NamespacesRequest:
      properties:
        namespaces:
          description: List of namespace strings (combination of database and collection)
            on the specified host or cluster.
          items:
            description: Human-readable label that identifies the namespace on the
              specified host or cluster. The resource expresses this parameter value
              as `<database>.<collection>`.
            type: string
            writeOnly: true
          type: array
          uniqueItems: true
          writeOnly: true
      type: object
    NetworkBytesInDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    NetworkBytesOutDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    NetworkNumRequestsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    NetworkPermissionEntry:
      properties:
        awsSecurityGroup:
          description: Unique string of the Amazon Web Services (AWS) security group
            that you want to add to the project's IP access list. Your IP access list
            entry can be one `awsSecurityGroup`, one `cidrBlock`, or one `ipAddress`.
            You must configure Virtual Private Connection (VPC) peering for your project
            before you can add an AWS security group to an IP access list. You cannot
            set AWS security groups as temporary access list entries. Don't set this
            parameter if you set `cidrBlock` or `ipAddress`.
          pattern: "^([0-9]*/)?sg-([0-9]*)"
          type: string
        cidrBlock:
          description: Range of IP addresses in Classless Inter-Domain Routing (CIDR)
            notation that you want to add to the project's IP access list. Your IP
            access list entry can be one `awsSecurityGroup`, one `cidrBlock`, or one
            `ipAddress`. Don't set this parameter if you set `awsSecurityGroup` or
            `ipAddress`.
          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})?$"
          type: string
        comment:
          description: Remark that explains the purpose or scope of this IP access
            list entry.
          maxLength: 80
          type: string
        deleteAfterDate:
          description: Date and time after which MongoDB Cloud deletes the temporary
            access list entry. This parameter expresses its value in the ISO 8601
            timestamp format in UTC and can include the time zone designation. The
            date must be later than the current date but no later than one week after
            you submit this request. The resource returns this parameter if you specified
            an expiration date when creating this IP access list entry.
          format: date-time
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that contains the IP access list to which you want to add one or more
            entries.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        ipAddress:
          description: IP address that you want to add to the project's IP access
            list. Your IP access list entry can be one `awsSecurityGroup`, one `cidrBlock`,
            or one `ipAddress`. Don't set this parameter if you set `awsSecurityGroup`
            or `cidrBlock`.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    NetworkPermissionEntryStatus:
      properties:
        STATUS:
          description: |-
            State of the access list entry when MongoDB Cloud made this request.

            `ACTIVE`: This access list entry applies to all relevant cloud providers.

            `PENDING`: MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request.

            `FAILED`: MongoDB Cloud didn't succeed in adding this access list entry.
          enum:
          - PENDING
          - FAILED
          - ACTIVE
          readOnly: true
          type: string
      required:
      - STATUS
      type: object
    NewRelic:
      description: |-
        Details to integrate one New Relic account with one MongoDB Cloud project.

        ***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.

        Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
      externalDocs:
        description: New Relic Plugin EOL Statement
        url: https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267
      properties:
        accountId:
          description: Unique 40-hexadecimal digit string that identifies your New
            Relic account.
          example: bcc3c81b344a6030a3935c2527e2216535af7718
          pattern: "^([0-9a-f]){40}$"
          type: string
        id:
          description: Integration id.
          nullable: true
          type: string
        licenseKey:
          description: |-
            Unique 40-hexadecimal digit string that identifies your New Relic license.

            **IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.
            Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.
          example: bc3768f44193c282b2688ab39e00f8e4fc8d75ea
          externalDocs:
            description: New Relic Plugin EOL Statement
            url: https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267
          pattern: "^([0-9a-f]){40}$"
          type: string
        readToken:
          description: Query key used to access your New Relic account.
          example: 193c96aee4a3ac640b98634562e2631f17ae0a69
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - NEW_RELIC
          type: string
        writeToken:
          description: Insert key associated with your New Relic account.
          example: a67b10e5cd7f8fb6a34b501136c409f373edc218
          type: string
      required:
      - accountId
      - licenseKey
      - readToken
      - writeToken
      title: NEW_RELIC
      type: object
    NormalizedFtsProcessCpuKernelRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    NormalizedFtsProcessCpuUserRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    NormalizedSystemCpuStealRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    NormalizedSystemCpuUserRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    NumberMetricAlertView:
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/NumberMetricValueView"
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: |-
            Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.

            To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.

            **NOTE**: If you set `eventTypeName` to `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
          example: ASSERT_USER
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      type: object
    NumberMetricEventView:
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/NumberMetricValueView"
        deskLocation:
          description: Desk location of MongoDB employee associated with the event.
          readOnly: true
          type: string
        employeeIdentifier:
          description: Identifier of MongoDB employee associated with the event.
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: Human-readable label of the metric associated with the `alertId`.
            This field may change type of `currentValue` field.
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      type: object
    NumberMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/NumberMetricUnits"
      required:
      - metricName
      type: object
    NumberMetricUnits:
      description: Element used to express the quantity. This can be an element of
        time, storage capacity, and the like.
      enum:
      - COUNT
      - THOUSAND
      - MILLION
      - BILLION
      example: COUNT
      title: Number Metric Units
      type: string
    NumberMetricValueView:
      description: Measurement of the `metricName` recorded at the time of the event.
      properties:
        number:
          description: Amount of the `metricName` recorded at the time of the event.
            This value triggered the alert.
          format: double
          readOnly: true
          type: number
        units:
          "$ref": "#/components/schemas/NumberMetricUnits"
      readOnly: true
      title: Number Metric Value
      type: object
    ObjectStoragePrivateEndpointRequest:
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          type: string
        regionName:
          description: Cloud provider region in which the Object Storage private endpoint
            is located.
          oneOf:
          - description: |-
              Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases.
              When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block.
              To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - AP_EAST_1
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTH_1
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - GLOBAL
            type: string
          type: object
      type: object
    ObjectStoragePrivateEndpointResponse:
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          type: string
        errorMessage:
          description: Error message for failures associated with the Object Storage
            private endpoint.
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the Private
            Endpoint Service.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        privateEndpointConnectionName:
          description: Connection name of the Private Endpoint.
          readOnly: true
          type: string
        regionName:
          description: Cloud provider region in which the Object Storage private endpoint
            is located.
          oneOf:
          - description: |-
              Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases.
              When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block.
              To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.
            enum:
            - US_GOV_WEST_1
            - US_GOV_EAST_1
            - US_EAST_1
            - US_EAST_2
            - US_WEST_1
            - US_WEST_2
            - CA_CENTRAL_1
            - EU_NORTH_1
            - EU_WEST_1
            - EU_WEST_2
            - EU_WEST_3
            - EU_CENTRAL_1
            - AP_EAST_1
            - AP_NORTHEAST_1
            - AP_NORTHEAST_2
            - AP_NORTHEAST_3
            - AP_SOUTHEAST_1
            - AP_SOUTHEAST_2
            - AP_SOUTHEAST_3
            - AP_SOUTH_1
            - SA_EAST_1
            - CN_NORTH_1
            - CN_NORTHWEST_1
            - ME_SOUTH_1
            - AF_SOUTH_1
            - EU_SOUTH_1
            - GLOBAL
            type: string
          type: object
        status:
          description: State of the Object Storage private endpoint.
          enum:
          - INITIATING
          - PENDING_ACCEPTANCE
          - ACTIVE
          - FAILED
          - PENDING_RECREATION
          - DELETING
          readOnly: true
          type: string
      type: object
    OnDemandCpsSnapshotSource:
      allOf:
      - "$ref": "#/components/schemas/IngestionSource"
      - properties:
          clusterName:
            description: Human-readable name that identifies the cluster.
            type: string
          collectionName:
            description: Human-readable name that identifies the collection.
            type: string
          databaseName:
            description: Human-readable name that identifies the database.
            type: string
          groupId:
            description: Unique 24-hexadecimal character string that identifies the
              project.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
        type: object
      description: On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.
      title: On-Demand Cloud Provider Snapshot Source
      type: object
    OnlineArchiveSchedule:
      description: Regular frequency and duration when archiving process occurs.
      discriminator:
        mapping:
          DAILY: "#/components/schemas/DailyScheduleView"
          DEFAULT: "#/components/schemas/DefaultScheduleView"
          MONTHLY: "#/components/schemas/MonthlyScheduleView"
          WEEKLY: "#/components/schemas/WeeklyScheduleView"
        propertyName: type
      oneOf:
      - "$ref": "#/components/schemas/DefaultScheduleView"
      - "$ref": "#/components/schemas/DailyScheduleView"
      - "$ref": "#/components/schemas/WeeklyScheduleView"
      - "$ref": "#/components/schemas/MonthlyScheduleView"
      properties:
        type:
          description: Type of schedule.
          enum:
          - DEFAULT
          - DAILY
          - WEEKLY
          - MONTHLY
          type: string
      required:
      - type
      title: Online Archive Schedule
      type: object
    OpCounterCmdRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterDeleteRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterGetMoreRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterInsertRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterQueryRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterReplCmdRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterReplDeleteRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterReplInsertRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterReplUpdateRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterTtlDeletedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OpCounterUpdateRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OperationThrottlingRejectedOperationsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OperationsQueriesKilledRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    OperationsScanAndOrderRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    Operator:
      description: Comparison operator to apply when checking the current metric value.
      enum:
      - "<"
      - ">"
      type: string
    OplogMasterLagTimeDiffTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    OplogMasterTimeEstimatedTtlTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    OplogMasterTimeTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    OplogRateGbPerHourDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    OplogSlaveLagMasterTimeTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    OpsGenie:
      description: Details to integrate one OpsGenie account with one MongoDB Cloud
        project.
      properties:
        apiKey:
          description: |-
            Key that allows MongoDB Cloud to access your OpsGenie account.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "********************************a111"
          type: string
        id:
          description: Integration id.
          nullable: true
          type: string
        region:
          default: US
          description: Two-letter code that indicates which regional URL MongoDB uses
            to access the OpsGenie API.
          enum:
          - US
          - EU
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - OPS_GENIE
          type: string
      required:
      - apiKey
      title: OPS_GENIE
      type: object
    OpsGenieNotification:
      description: OpsGenie notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        opsGenieApiKey:
          description: |-
            API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when `"notifications.[n].typeName" : "OPS_GENIE"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "********************************a111"
          type: string
        opsGenieRegion:
          default: US
          description: OpsGenie region that indicates which API Uniform Resource Locator
            (URL) to use.
          enum:
          - US
          - EU
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - OPS_GENIE
          type: string
      required:
      - typeName
      title: OpsGenie Notification
      type: object
    OrgActiveUserResponse:
      allOf:
      - "$ref": "#/components/schemas/OrgUserResponse"
      - properties:
          country:
            description: Two-character alphabetical string that identifies the MongoDB
              Cloud user's geographic location. This parameter uses the ISO 3166-1a2
              code format.
            example: US
            pattern: "^([A-Z]{2})$"
            readOnly: true
            type: string
          createdAt:
            description: Date and time when MongoDB Cloud created the current account.
              This value is in the ISO 8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          firstName:
            description: First or given name that belongs to the MongoDB Cloud user.
            example: John
            readOnly: true
            type: string
          lastAuth:
            description: Date and time when the current account last authenticated.
              This value is in the ISO 8601 timestamp format in UTC.
            format: date-time
            readOnly: true
            type: string
          lastName:
            description: Last name, family name, or surname that belongs to the MongoDB
              Cloud user.
            example: Doe
            readOnly: true
            type: string
          mobileNumber:
            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})$"
            readOnly: true
            type: string
        type: object
      required:
      - createdAt
      - firstName
      - id
      - lastName
      - orgMembershipStatus
      - roles
      - username
      type: object
    OrgEventTypeViewForOrg:
      description: Unique identifier of event type.
      enum:
      - ORG_CREATED
      - CUSTOM_SESSION_TIMEOUT_MODIFIED
      - SECURITY_CONTACT_MODIFIED
      - ORG_CREDIT_CARD_ADDED
      - ORG_CREDIT_CARD_UPDATED
      - ORG_CREDIT_CARD_CURRENT
      - ORG_CREDIT_CARD_ABOUT_TO_EXPIRE
      - ORG_PAYPAL_LINKED
      - ORG_PAYPAL_UPDATED
      - ORG_PAYPAL_CANCELLED
      - ORG_OVERRIDE_PAYMENT_METHOD_ADDED
      - ORG_BANK_ACCOUNT_ADDED
      - ORG_BANK_ACCOUNT_UPDATED
      - ORG_WALLET_ADDED
      - ORG_WALLET_UPDATED
      - ORG_ACTIVATED
      - ORG_TEMPORARILY_ACTIVATED
      - ORG_SUSPENSION_DATE_CHANGED
      - ORG_SUSPENDED
      - ORG_ADMIN_SUSPENDED
      - ORG_ADMIN_LOCKED
      - ORG_CLUSTERS_DELETED
      - ORG_CLUSTERS_PAUSED
      - ORG_LOCKED
      - ORG_LOCKED_ACCELERATED
      - ORG_UNDER_FINANCIAL_PROTECTION
      - ORG_NO_FINANCIAL_PROTECTION
      - ORG_RENAMED
      - ALL_ORG_USERS_HAVE_MFA
      - ORG_USERS_WITHOUT_MFA
      - ORG_INVOICE_UNDER_THRESHOLD
      - ORG_INVOICE_OVER_THRESHOLD
      - ORG_DAILY_BILL_UNDER_THRESHOLD
      - ORG_DAILY_BILL_OVER_THRESHOLD
      - ORG_DAILY_BILLING_CHANGE_NORMAL
      - ORG_DAILY_BILLING_CHANGE_OVER_THRESHOLD
      - ORG_WEEKLY_BILLING_CHANGE_NORMAL
      - ORG_WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
      - ORG_MONTHLY_BILLING_CHANGE_NORMAL
      - ORG_MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
      - ORG_GROUP_CHARGES_UNDER_THRESHOLD
      - ORG_GROUP_CHARGES_OVER_THRESHOLD
      - ORG_TWO_FACTOR_AUTH_REQUIRED
      - ORG_TWO_FACTOR_AUTH_OPTIONAL
      - ORG_PUBLIC_API_ACCESS_LIST_REQUIRED
      - ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED
      - ORG_EMPLOYEE_ACCESS_RESTRICTED
      - ORG_EMPLOYEE_ACCESS_UNRESTRICTED
      - ORG_CONNECTED_TO_MLAB
      - ORG_DISCONNECTED_FROM_MLAB
      - ORG_IDP_CERTIFICATE_CURRENT
      - ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE
      - ORG_CONNECTED_TO_VERCEL
      - ORG_DISCONNECTED_TO_VERCEL
      - ORG_CONNECTION_UNINSTALLED_FROM_VERCEL
      - ORG_UI_IP_ACCESS_LIST_ENABLED
      - ORG_UI_IP_ACCESS_LIST_DISABLED
      - ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES
      - ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED
      - ORG_SERVICE_ACCOUNT_SECRETS_EXPIRED
      - ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED
      - ORG_SERVICE_ACCOUNT_SECRETS_EXPIRING
      - ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING
      - ORG_MONGODB_VERSION_EOL_EXTENSION_ACCEPTED
      - ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING
      - ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED
      - ORG_BAAS_EOL_EXTENSION_ACCEPTED
      - ORG_BAAS_EOL_EXTENSION_PENDING
      - ORG_BAAS_EOL_EXTENSION_CANCELED
      - GROUP_MOVED_FROM_ORG
      - SANDBOX_ENABLED_FOR_ORG
      - SANDBOX_DISABLED_FOR_ORG
      - SANDBOX_CONFIG_DELETED
      - SANDBOX_TEMPLATE_UPDATED
      - ORGANIZATION_VOYAGE_SETTINGS_CREATED
      - ORGANIZATION_VOYAGE_SETTINGS_DELETED
      - PROJECT_CREATED_VIA_ANIS
      example: ORG_CREATED
      title: Org Event Types
      type: string
    OrgEventViewForOrg:
      description: Organization event identifies different activities and changes
        in an organization settings.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/OrgEventTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        invoiceId:
          description: Unique 24-hexadecimal digit string that identifies of the invoice
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Organization Events
      type: object
    OrgFederationSettings:
      description: Details that define how to connect one MongoDB Cloud organization
        to one federated authentication service.
      properties:
        federatedDomains:
          description: List of domains associated with the organization's identity
            provider.
          items:
            type: string
          type: array
          uniqueItems: true
        hasRoleMappings:
          description: Flag that indicates whether this organization has role mappings
            configured.
          type: boolean
        id:
          description: Unique 24-hexadecimal digit string that identifies this federation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        identityProviderId:
          description: Legacy 20-hexadecimal digit string that identifies the identity
            provider connected to this organization.
          example: c2777a9eca931f29fc2f
          pattern: "^([a-f0-9]{20})$"
          type: string
        identityProviderStatus:
          description: String enum that indicates whether the identity provider is
            active.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
      required:
      - federatedDomains
      title: Organization Federation Settings
      type: object
    OrgGroup:
      properties:
        clusters:
          description: Settings that describe the clusters in each project that the
            API key is authorized to view.
          items:
            "$ref": "#/components/schemas/CloudCluster"
          readOnly: true
          type: array
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          readOnly: true
          type: string
        groupName:
          description: Human-readable label that identifies the project.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that contains the project.
          readOnly: true
          type: string
        orgName:
          description: Human-readable label that identifies the organization that
            contains the project.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
        planType:
          description: Human-readable label that indicates the plan type.
          readOnly: true
          type: string
        tags:
          description: List of human-readable labels that categorize the specified
            project. MongoDB Cloud returns an empty array.
          items:
            readOnly: true
            type: string
          readOnly: true
          type: array
      type: object
    OrgNotification:
      description: Organization notification configuration for MongoDB Cloud to send
        information when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        emailEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        roles:
          description: 'List that contains the one or more organization roles that
            receive the configured alert. This parameter is available when `"notifications.[n].typeName"
            : "GROUP"` or `"notifications.[n].typeName" : "ORG"`. If you include this
            parameter, MongoDB Cloud sends alerts only to users assigned the roles
            you specify in the array. If you omit this parameter, MongoDB Cloud sends
            alerts to users assigned any role.'
          externalDocs:
            description: Organization Roles
            url: https://dochub.mongodb.org/core/atlas-org-roles
          items:
            description: One or more organization roles that receive the configured
              alert.
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_READ_ONLY
            type: string
          type: array
        smsEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - ORG
          type: string
      required:
      - typeName
      title: Organization Notification
      type: object
    OrgPaginatedEventView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/EventViewForOrg"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    OrgPendingUserResponse:
      allOf:
      - "$ref": "#/components/schemas/OrgUserResponse"
      - properties:
          invitationCreatedAt:
            description: Date and time when MongoDB Cloud sent the invitation. MongoDB
              Cloud represents this timestamp in ISO 8601 format in UTC.
            format: date-time
            readOnly: true
            type: string
          invitationExpiresAt:
            description: Date and time when the invitation from MongoDB Cloud expires.
              MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
            format: date-time
            readOnly: true
            type: string
          inviterUsername:
            description: Username of the MongoDB Cloud user who sent the invitation
              to join the organization.
            format: email
            readOnly: true
            type: string
        type: object
      required:
      - id
      - invitationCreatedAt
      - invitationExpiresAt
      - inviterUsername
      - orgMembershipStatus
      - roles
      - username
      type: object
    OrgServiceAccount:
      description: Organization Service Account that Atlas created for the organization.
      properties:
        clientId:
          description: The Client ID of the Service Account.
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
        createdAt:
          description: The date that the Service Account was created on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        description:
          description: Human readable description for the Service Account.
          type: string
        name:
          description: Human-readable name for the Service Account.
          type: string
        roles:
          description: A list of Organization roles associated with the Service Account.
          items:
            description: Organization roles available for Service Accounts.
            enum:
            - ORG_MEMBER
            - ORG_READ_ONLY
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_GROUP_CREATOR
            - ORG_OWNER
            type: string
          type: array
          uniqueItems: true
        secrets:
          description: A list of secrets associated with the specified Service Account.
          items:
            "$ref": "#/components/schemas/ServiceAccountSecret"
          type: array
          uniqueItems: true
      readOnly: true
      type: object
    OrgServiceAccountRequest:
      description: Organization Service Account that Atlas creates for this organization.
        If omitted, Atlas doesn't create an organization Service Account for this
        organization. If specified, this object requires all body parameters. Note
        that API Keys cannot be specified in the same request.
      properties:
        description:
          description: Human readable description for the Service Account.
          maxLength: 250
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        name:
          description: Human-readable name for the Service Account. The name is modifiable
            and does not have to be unique.
          maxLength: 64
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        roles:
          description: A list of organization-level roles for the Service Account.
          items:
            description: Organization roles available for Service Accounts.
            enum:
            - ORG_MEMBER
            - ORG_READ_ONLY
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_GROUP_CREATOR
            - ORG_OWNER
            type: string
          minItems: 1
          type: array
        secretExpiresAfterHours:
          description: The expiration time of the new Service Account secret, provided
            in hours. The minimum and maximum allowed expiration times are subject
            to change and are controlled by the organization's settings.
          example: 8
          format: int32
          type: integer
      required:
      - description
      - name
      - roles
      - secretExpiresAfterHours
      type: object
    OrgServiceAccountUpdateRequest:
      properties:
        description:
          description: Human readable description for the Service Account.
          maxLength: 250
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        name:
          description: Human-readable name for the Service Account. The name is modifiable
            and does not have to be unique.
          maxLength: 64
          minLength: 1
          pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$"
          type: string
        roles:
          description: A list of organization-level roles for the Service Account.
          items:
            description: Organization roles available for Service Accounts.
            enum:
            - ORG_MEMBER
            - ORG_READ_ONLY
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_GROUP_CREATOR
            - ORG_OWNER
            type: string
          type: array
      type: object
    OrgUserRequest:
      properties:
        roles:
          "$ref": "#/components/schemas/OrgUserRolesRequest"
        teamIds:
          description: List of unique 24-hexadecimal digit strings that identifies
            the teams to which this MongoDB Cloud user belongs.
          items:
            type: string
          type: array
          uniqueItems: true
          writeOnly: true
        username:
          description: Email address that represents the username of the MongoDB Cloud
            user.
          format: email
          type: string
          writeOnly: true
      required:
      - roles
      - username
      type: object
    OrgUserResponse:
      discriminator:
        mapping:
          ACTIVE: "#/components/schemas/OrgActiveUserResponse"
          PENDING: "#/components/schemas/OrgPendingUserResponse"
        propertyName: orgMembershipStatus
      oneOf:
      - "$ref": "#/components/schemas/OrgPendingUserResponse"
      - "$ref": "#/components/schemas/OrgActiveUserResponse"
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the MongoDB
            Cloud user.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        orgMembershipStatus:
          description: String enum that indicates whether the MongoDB Cloud user has
            a pending invitation to join the organization or they are already active
            in the organization.
          enum:
          - PENDING
          - ACTIVE
          readOnly: true
          type: string
        roles:
          "$ref": "#/components/schemas/OrgUserRolesResponse"
        teamIds:
          description: List of unique 24-hexadecimal digit strings that identifies
            the teams to which this MongoDB Cloud user belongs.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          readOnly: true
          type: array
          uniqueItems: true
        username:
          description: Email address that represents the username of the MongoDB Cloud
            user.
          format: email
          readOnly: true
          type: string
      required:
      - id
      - orgMembershipStatus
      - roles
      - username
      type: object
    OrgUserRolesRequest:
      description: Organization and project level roles to assign the MongoDB Cloud
        user within one organization.
      properties:
        groupRoleAssignments:
          description: List of project level role assignments to assign the MongoDB
            Cloud user.
          items:
            "$ref": "#/components/schemas/GroupRoleAssignment"
          type: array
        orgRoles:
          description: One or more organization level roles to assign the MongoDB
            Cloud user.
          items:
            description: Organization-level role.
            enum:
            - ORG_OWNER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            - ORG_MEMBER
            type: string
          minItems: 1
          type: array
          uniqueItems: true
      required:
      - orgRoles
      type: object
      writeOnly: true
    OrgUserRolesResponse:
      description: Organization- and project-level roles assigned to one MongoDB Cloud
        user within one organization.
      properties:
        groupRoleAssignments:
          description: List of project-level role assignments assigned to the MongoDB
            Cloud user.
          items:
            "$ref": "#/components/schemas/GroupRoleAssignment"
          type: array
        orgRoles:
          description: One or more organization-level roles assigned to the MongoDB
            Cloud user.
          items:
            description: Organization-level role.
            enum:
            - ORG_OWNER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            - ORG_MEMBER
            type: string
          type: array
          uniqueItems: true
      readOnly: true
      type: object
    OrgUserUpdateRequest:
      properties:
        roles:
          "$ref": "#/components/schemas/OrgUserRolesRequest"
        teamIds:
          description: List of unique 24-hexadecimal digit strings that identifies
            the teams to assign the MongoDB Cloud user.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          type: array
          uniqueItems: true
          writeOnly: true
      type: object
    OrganizationInvitation:
      properties:
        createdAt:
          description: Date and time when MongoDB Cloud sent the invitation. MongoDB
            Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        expiresAt:
          description: Date and time when the invitation from MongoDB Cloud expires.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        groupRoleAssignments:
          description: List of projects that the user will be added to when they accept
            their invitation to the organization.
          items:
            "$ref": "#/components/schemas/GroupRole"
          type: array
          uniqueItems: true
        id:
          description: Unique 24-hexadecimal digit string that identifies this invitation.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        inviterUsername:
          description: Email address of the MongoDB Cloud user who sent the invitation
            to join the organization.
          format: email
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        orgName:
          description: Human-readable label that identifies this organization.
          pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
          type: string
        roles:
          description: One or more organization-level roles to assign to the MongoDB
            Cloud user.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          type: array
          uniqueItems: true
        teamIds:
          description: List of unique 24-hexadecimal digit strings that identifies
            each team.
          items:
            description: Unique 24-hexadecimal digit string that identifies the team.
            type: string
          readOnly: true
          type: array
          uniqueItems: true
        username:
          description: Email address of the MongoDB Cloud user invited to join the
            organization.
          format: email
          type: string
      required:
      - orgName
      type: object
    OrganizationInvitationGroupRoleAssignmentsRequest:
      properties:
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            to which these roles belong.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        roles:
          description: One or more project-level roles to assign to the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Atlas User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    OrganizationInvitationRequest:
      properties:
        groupRoleAssignments:
          description: List of projects that the user will be added to when they accept
            their invitation to the organization.
          items:
            "$ref": "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest"
          type: array
        roles:
          description: One or more organization level roles to assign to the MongoDB
            Cloud user.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          type: array
          uniqueItems: true
        teamIds:
          description: List of teams to which you want to invite the desired MongoDB
            Cloud user.
          items:
            description: Unique 24-hexadecimal digit string that identifies the team.
            type: string
          type: array
          uniqueItems: true
        username:
          description: Email address that belongs to the desired MongoDB Cloud user.
          format: email
          type: string
      type: object
    OrganizationInvitationUpdateRequest:
      properties:
        groupRoleAssignments:
          description: List of projects that the user will be added to when they accept
            their invitation to the organization.
          items:
            "$ref": "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest"
          type: array
        roles:
          description: One or more organization level roles to assign to the MongoDB
            Cloud user.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          type: array
          uniqueItems: true
        teamIds:
          description: List of teams to which you want to invite the desired MongoDB
            Cloud user.
          items:
            description: Unique 24-hexadecimal digit string that identifies the team.
            type: string
          type: array
          uniqueItems: true
      type: object
    OrganizationSettings:
      description: Collection of settings that configures the organization.
      properties:
        apiAccessListRequired:
          description: Flag that indicates whether to require API operations to originate
            from an IP Address added to the API access list for the specified organization.
          type: boolean
        customSessionTimeouts:
          "$ref": "#/components/schemas/CustomSessionTimeouts"
        genAIFeaturesEnabled:
          default: true
          description: Flag that indicates whether this organization has access to
            generative AI features. This setting only applies to Atlas Commercial
            and is enabled by default. Once this setting is turned on, Project Owners
            may be able to enable or disable individual AI features at the project
            level.
          externalDocs:
            description: Generative AI FAQs
            url: https://www.mongodb.com/docs/generative-ai-faq/
          type: boolean
        maxServiceAccountSecretValidityInHours:
          description: Number that represents the maximum period before expiry in
            hours for new Atlas Admin API Service Account secrets within the specified
            organization.
          format: int32
          maximum: 8760
          minimum: 8
          type: integer
        multiFactorAuthRequired:
          description: 'Flag that indicates whether to require users to set up Multi-Factor
            Authentication (MFA) before accessing the specified organization. To learn
            more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.'
          type: boolean
        restrictEmployeeAccess:
          description: 'Flag that indicates whether to block MongoDB Support from
            accessing Atlas infrastructure and cluster logs for any deployment in
            the specified organization without explicit permission. Once this setting
            is turned on, you can grant MongoDB Support a 24-hour bypass access to
            the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.'
          type: boolean
        securityContact:
          description: String that specifies a single email address for the specified
            organization to receive security-related notifications. Specifying a security
            contact does not grant them authorization or access to Atlas for security
            decisions or approvals. An empty string is valid and clears the existing
            security contact (if any).
          type: string
        streamsCrossGroupEnabled:
          description: Flag that indicates whether a group's Atlas Stream Processing
            workspaces in this organization can create connections to other group's
            clusters in the same organization.
          type: boolean
      type: object
    OtelLogIntegrationRequest:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationRequest"
      - properties:
          otelEndpoint:
            description: OpenTelemetry collector endpoint URL. Must be HTTPS and not
              exceed 2048 characters.
            example: https://otel-collector.example.com:4318/v1/logs
            type: string
          otelSuppliedHeaders:
            description: HTTP headers for authentication and configuration. Maximum
              10 headers, total size limit 2KB.
            items:
              "$ref": "#/components/schemas/Header"
            maxItems: 10
            minItems: 1
            type: array
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - OTEL_LOG_EXPORT
            type: string
        type: object
      description: Request schema for creating or updating an OpenTelemetry log export
        integration.
      required:
      - logTypes
      - otelEndpoint
      - otelSuppliedHeaders
      - type
      title: OTel Log Export Integration Request
      type: object
    OtelLogIntegrationResponse:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationResponse"
      - properties:
          otelEndpoint:
            description: OpenTelemetry collector endpoint URL.
            example: https://otel-collector.example.com:4318/v1/logs
            type: string
          otelSuppliedHeaders:
            description: HTTP headers for authentication and configuration. Maximum
              10 headers, total size limit 2KB.
            items:
              "$ref": "#/components/schemas/Header"
            maxItems: 10
            minItems: 1
            type: array
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - OTEL_LOG_EXPORT
            type: string
        type: object
      description: Details to integrate OpenTelemetry log export with one Atlas project.
      required:
      - id
      - logTypes
      - otelEndpoint
      - otelSuppliedHeaders
      - type
      title: OTel Log Export Integration Response
      type: object
    OutboundControlPlaneCloudProviderIPAddresses:
      description: List of outbound IP addresses from the Atlas control plane, categorized
        by cloud provider. If your network allows inbound HTTP requests only from
        specific IP addresses, you must allow access from the following IP addresses
        so that Atlas can communicate with your webhooks and KMS.
      properties:
        aws:
          additionalProperties:
            description: Control plane IP addresses in AWS. Each key identifies an
              Amazon Web Services (AWS) region. Each value identifies control plane
              IP addresses in the AWS region.
            items:
              description: Control plane IP addresses in AWS. Each key identifies
                an Amazon Web Services (AWS) region. Each value identifies control
                plane IP addresses in the AWS region.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: Control plane IP addresses in AWS. Each key identifies an Amazon
            Web Services (AWS) region. Each value identifies control plane IP addresses
            in the AWS region.
          readOnly: true
          type: object
        azure:
          additionalProperties:
            description: Control plane IP addresses in Azure. Each key identifies
              an Azure region. Each value identifies control plane IP addresses in
              the Azure region.
            items:
              description: Control plane IP addresses in Azure. Each key identifies
                an Azure region. Each value identifies control plane IP addresses
                in the Azure region.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: Control plane IP addresses in Azure. Each key identifies an
            Azure region. Each value identifies control plane IP addresses in the
            Azure region.
          readOnly: true
          type: object
        gcp:
          additionalProperties:
            description: Control plane IP addresses in GCP. Each key identifies a
              Google Cloud (GCP) region. Each value identifies control plane IP addresses
              in the GCP region.
            items:
              description: Control plane IP addresses in GCP. Each key identifies
                a Google Cloud (GCP) region. Each value identifies control plane IP
                addresses in the GCP region.
              readOnly: true
              type: string
            readOnly: true
            type: array
          description: Control plane IP addresses in GCP. Each key identifies a Google
            Cloud (GCP) region. Each value identifies control plane IP addresses in
            the GCP region.
          readOnly: true
          type: object
      readOnly: true
      title: Outbound Control Plane IP Addresses By Cloud Provider
      type: object
    PagerDuty:
      description: Details to integrate one PagerDuty account with one MongoDB Cloud
        project.
      properties:
        id:
          description: Integration id.
          nullable: true
          type: string
        region:
          description: PagerDuty region that indicates the API Uniform Resource Locator
            (URL) to use.
          enum:
          - US
          - EU
          type: string
        serviceKey:
          description: |-
            Service key associated with your PagerDuty account.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "****************************7890"
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - PAGER_DUTY
          type: string
      required:
      - serviceKey
      title: PAGER_DUTY
      type: object
    PagerDutyNotification:
      description: PagerDuty notification configuration for MongoDB Cloud to send
        information when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        region:
          default: US
          description: PagerDuty region that indicates which API Uniform Resource
            Locator (URL) to use.
          enum:
          - US
          - EU
          type: string
        serviceKey:
          description: |-
            PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `"notifications.[n].typeName" : "PAGER_DUTY"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "****************************7890"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - PAGER_DUTY
          type: string
      required:
      - typeName
      title: PagerDuty Notification
      type: object
    PaginatedAlertConfigView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/GroupAlertsConfig"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedAlertView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/AlertViewForNdsGroup"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiApiUserView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ApiKeyUserDetails"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAppUserView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/CloudAppUser"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasCheckpointView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ApiAtlasCheckpointView"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasDatabaseUserView:
      description: List of MongoDB Database users granted access to databases in the
        specified project.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/CloudDatabaseUser"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasDiskBackupExportJobView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/DiskBackupExportJob"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasEARPrivateEndpointView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/EARPrivateEndpoint"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasFlexBackupRestoreJob20241113View:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/FlexBackupRestoreJob20241113"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasFlexBackupSnapshot20241113View:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/FlexBackupSnapshot20241113"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasObjectStoragePrivateEndpointResponseView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ObjectStoragePrivateEndpointResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasProviderRegionsView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/CloudProviderRegions"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasServerlessBackupRestoreJobView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ServerlessBackupRestoreJob"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiAtlasServerlessBackupSnapshotView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ServerlessBackupSnapshot"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiInvoiceMetadataView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/BillingInvoiceMetadata"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiInvoiceView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/BillingInvoice"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiSKUView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/SkuResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiStreamsConnectionView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/StreamsConnection"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiStreamsPrivateLinkView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/StreamsPrivateLinkConnection"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiStreamsStreamProcessorWithStatsView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/StreamsProcessorWithStats"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiStreamsTenantView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/StreamsTenant"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiStreamsVPCPeeringConnectionView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/VPCPeeringConnection"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedApiUserAccessListResponseView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/UserAccessListResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedAtlasGroupView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/Group"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedAvailableVersionView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/MdbAvailableVersion"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedBackupSnapshotExportBucketsView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedBackupSnapshotView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/DiskBackupSnapshot"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedCloudBackupReplicaSetView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/DiskBackupReplicaSet"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedCloudBackupRestoreJobView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedCloudBackupShardedClusterSnapshotView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshot"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedCloudProviderContainerView:
      description: List of Network Peering Containers that Amazon Web Services serves.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/CloudProviderContainer"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      title: Network Peering
      type: object
    PaginatedClusterDescription20240805:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ClusterDescription20240805"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedConnectedOrgConfigsView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ConnectedOrgConfig"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedContainerPeerView:
      description: Group of Network Peering connection settings.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedDatabaseView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/MesurementsDatabase"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedDiskPartitionView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/MeasurementDiskPartition"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedEventTypeDetailsResponse:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/EventTypeDetails"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedFederationIdentityProvider:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/FederationIdentityProvider"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedFlexClusters20241113:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/FlexClusterDescription20241113"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedGroupServiceAccounts:
      description: A list of Project Service Accounts.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/GroupServiceAccount"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedGroupUserView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/GroupUserResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedHostView_Atlas:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link_Atlas"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ApiHostView_Atlas"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedIntegrationView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ThirdPartyIntegration"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedLogIntegrationResponse:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/LogIntegrationResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedNetworkAccessView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/NetworkPermissionEntry"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedOnlineArchiveView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/BackupOnlineArchive"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedOrgGroupView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/OrgGroup"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedOrgServiceAccounts:
      description: A list of Organization Service Accounts.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/OrgServiceAccount"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedOrgUserView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/OrgUserResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedOrganizationView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/AtlasOrganization"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedPipelineRunView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/IngestionPipelineRun"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedPrivateNetworkEndpointIdEntryView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedPublicApiUsageDetailsLineItemView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/PublicApiUsageDetailsLineItemView"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedQueryShapes:
      description: Paginated collection of query shapes. This endpoint returns a maximum
        of 100 results.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/QueryShapeResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedRateLimitEndpointSets:
      description: A list of rate limit endpoint sets.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/RateLimitEndpointSetResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedRestoreJobView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/BackupRestoreJob"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedRoleMappingView:
      description: List role mappings from the specified organization in the specified
        federation.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/AuthFederationRoleMapping"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedServerlessInstanceDescriptionView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ServerlessInstanceDescription"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedServiceAccountGroup:
      description: A list of projects associated with the Service Account.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ServiceAccountGroup"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedServiceAccountIPAccessEntryView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/ServiceAccountIPAccessListEntry"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedSnapshotView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/BackupSnapshot"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedTeamRoleView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/TeamRole"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedTeamView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/TeamResponse"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PaginatedUserCertView:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        results:
          description: List of returned documents that MongoDB Cloud provides when
            completing this request.
          items:
            "$ref": "#/components/schemas/UserCert"
          readOnly: true
          type: array
        totalCount:
          description: Total number of documents available. MongoDB Cloud omits this
            value if `includeCount` is set to `false`. The total number is an estimate
            and may not be exact.
          format: int32
          minimum: 0
          readOnly: true
          type: integer
      required:
      - results
      type: object
    PartitionFieldView:
      description: Metadata to partition this online archive.
      properties:
        fieldName:
          description: Human-readable label that identifies the parameter that MongoDB
            Cloud uses to partition data. To specify a nested parameter, use the dot
            notation.
          maxLength: 700
          type: string
        fieldType:
          description: Data type of the parameter that that MongoDB Cloud uses to
            partition data. Partition parameters of type UUID must be of binary subtype
            4. MongoDB Cloud skips partition parameters of type UUID with subtype
            3.
          enum:
          - date
          - int
          - long
          - objectId
          - string
          - uuid
          externalDocs:
            description: UUID
            url: http://bsonspec.org/spec.html
          readOnly: true
          type: string
        order:
          default: 0
          description: Sequence in which MongoDB Cloud slices the collection data
            to create partitions. The resource expresses this sequence starting with
            zero. The value of the `criteria.dateField` parameter defaults as the
            first item in the partition sequence.
          format: int32
          type: integer
      required:
      - fieldName
      - order
      title: Online Archive Partition
      type: object
    PemFileInfo:
      description: PEM file information for the identity provider's current certificates.
      properties:
        certificates:
          description: List of certificates in the file.
          items:
            "$ref": "#/components/schemas/X509Certificate"
          type: array
        fileName:
          description: Human-readable label given to the file.
          type: string
      type: object
    PemFileInfoUpdate:
      description: PEM file information for the identity provider's current certificates.
      properties:
        certificates:
          description: List of certificates in the file.
          items:
            "$ref": "#/components/schemas/X509CertificateUpdate"
          type: array
        fileName:
          description: Human-readable label given to the file.
          type: string
      type: object
    PerformanceAdvisorIndex:
      properties:
        avgObjSize:
          description: The average size of an object in the collection of this index.
          format: double
          readOnly: true
          type: number
        id:
          description: Unique 24-hexadecimal digit string that identifies this index.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        impact:
          description: List that contains unique 24-hexadecimal character string that
            identifies the query shapes in this response that the Performance Advisor
            suggests.
          items:
            description: One unique 24-hexadecimal character string that identifies
              one query shape.
            type: string
          readOnly: true
          type: array
        index:
          description: List that contains documents that specify a key in the index
            and its sort order.
          items:
            additionalProperties:
              description: One index key paired with its sort order. A value of `1`
                indicates an ascending sort order. A value of `-1` indicates a descending
                sort order. Keys in indexes with multiple keys appear in the same
                order that they appear in the index.
              enum:
              - 1
              - -1
              format: int32
              type: integer
            description: One index key paired with its sort order. A value of `1`
              indicates an ascending sort order. A value of `-1` indicates a descending
              sort order. Keys in indexes with multiple keys appear in the same order
              that they appear in the index.
            type: object
          readOnly: true
          type: array
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          readOnly: true
          type: string
        weight:
          description: Estimated performance improvement that the suggested index
            provides. This value corresponds to **Impact** in the Performance Advisor
            user interface.
          format: double
          readOnly: true
          type: number
      type: object
    PerformanceAdvisorOpStats:
      description: Details that this resource returned about the specified query.
      properties:
        ms:
          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. This parameter relates to the **duration**
            query parameter.
          format: int64
          readOnly: true
          type: integer
        nReturned:
          description: Number of results that the query returns.
          format: int64
          readOnly: true
          type: integer
        nScanned:
          description: Number of documents that the query read.
          format: int64
          readOnly: true
          type: integer
        ts:
          description: Date and time from which the query retrieves the suggested
            indexes. This parameter expresses its value in the number of seconds that
            have elapsed since the UNIX epoch. This parameter relates to the **since**
            query parameter.
          externalDocs:
            description: UNIX Epoch
            url: https://en.wikipedia.org/wiki/Unix_time
          format: int64
          readOnly: true
          type: integer
      readOnly: true
      type: object
    PerformanceAdvisorOperationView:
      properties:
        predicates:
          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:
            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
            type: object
          readOnly: true
          type: array
        stats:
          "$ref": "#/components/schemas/PerformanceAdvisorOpStats"
      type: object
    PerformanceAdvisorResponse:
      properties:
        shapes:
          description: List of query predicates, sorts, and projections that the Performance
            Advisor suggests.
          items:
            "$ref": "#/components/schemas/PerformanceAdvisorShape"
          readOnly: true
          type: array
        suggestedIndexes:
          description: List that contains the documents with information about the
            indexes that the Performance Advisor suggests.
          items:
            "$ref": "#/components/schemas/PerformanceAdvisorIndex"
          readOnly: true
          type: array
      type: object
    PerformanceAdvisorShape:
      properties:
        avgMs:
          description: Average duration in milliseconds for the queries examined that
            match this shape.
          format: int64
          readOnly: true
          type: integer
        count:
          description: Number of queries examined that match this shape.
          format: int64
          readOnly: true
          type: integer
        id:
          description: Unique 24-hexadecimal digit string that identifies this shape.
            This string exists only for the duration of this API request.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        inefficiencyScore:
          description: Average number of documents read for every document that the
            query returns.
          externalDocs:
            description: Understanding the Query Inefficiency Score
            url: https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score
          format: int64
          readOnly: true
          type: integer
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          readOnly: true
          type: string
        operations:
          description: List that contains specific about individual queries.
          items:
            "$ref": "#/components/schemas/PerformanceAdvisorOperationView"
          readOnly: true
          type: array
      type: object
    PerformanceAdvisorSlowQuery:
      description: Details of one slow query that the Performance Advisor detected.
      properties:
        line:
          description: Text of the MongoDB log related to this slow query.
          readOnly: true
          type: string
        metrics:
          "$ref": "#/components/schemas/PerformanceAdvisorSlowQueryMetrics"
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          readOnly: true
          type: string
        opType:
          description: Operation type (read/write/command) associated with this slow
            query log.
          readOnly: true
          type: string
        replicaState:
          description: Replica state associated with this slow query log.
          readOnly: true
          type: string
      readOnly: true
      type: object
    PerformanceAdvisorSlowQueryList:
      properties:
        slowQueries:
          description: List of operations that the Performance Advisor detected that
            took longer to execute than a specified threshold.
          items:
            "$ref": "#/components/schemas/PerformanceAdvisorSlowQuery"
          readOnly: true
          type: array
      type: object
    PerformanceAdvisorSlowQueryMetrics:
      description: Metrics from a slow query log.
      properties:
        docsExamined:
          description: The number of documents in the collection that MongoDB scanned
            in order to carry out the operation.
          format: int64
          readOnly: true
          type: integer
        docsExaminedReturnedRatio:
          description: Ratio of documents examined to documents returned.
          format: double
          readOnly: true
          type: number
        docsReturned:
          description: The number of documents returned by the operation.
          format: int64
          readOnly: true
          type: integer
        fromUserConnection:
          description: This boolean will be true when the server can identify the
            query source as non-server. This field is only available for MDB 8.0+.
          readOnly: true
          type: boolean
        hasIndexCoverage:
          description: Indicates if the query has index coverage.
          readOnly: true
          type: boolean
        hasSort:
          description: This boolean will be true when a query cannot use the ordering
            in the index to return the requested sorted results; i.e. MongoDB must
            sort the documents after it receives the documents from a cursor.
          readOnly: true
          type: boolean
        keysExamined:
          description: The number of index keys that MongoDB scanned in order to carry
            out the operation.
          format: int64
          readOnly: true
          type: integer
        keysExaminedReturnedRatio:
          description: Ratio of keys examined to documents returned.
          format: double
          readOnly: true
          type: number
        numYields:
          description: The number of times the operation yielded to allow other operations
            to complete.
          format: int64
          readOnly: true
          type: integer
        operationExecutionTime:
          description: Total execution time of a query in milliseconds.
          format: int64
          readOnly: true
          type: integer
        responseLength:
          description: The length in bytes of the operation's result document.
          format: int64
          readOnly: true
          type: integer
      readOnly: true
      type: object
    PeriodicCpsSnapshotSource:
      allOf:
      - "$ref": "#/components/schemas/IngestionSource"
      - properties:
          clusterName:
            description: Human-readable name that identifies the cluster.
            type: string
          collectionName:
            description: Human-readable name that identifies the collection.
            type: string
          databaseName:
            description: Human-readable name that identifies the database.
            type: string
          groupId:
            description: Unique 24-hexadecimal character string that identifies the
              project.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            readOnly: true
            type: string
          policyItemId:
            description: Unique 24-hexadecimal character string that identifies a
              policy item.
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
        type: object
      description: Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
      title: Periodic Cloud Provider Snapshot Source
      type: object
    PinFCVView:
      properties:
        expirationDate:
          description: Expiration date of the fixed FCV. If not specified, the expiration
            date will default to 4 weeks from the date FCV was originally pinned.
            Note that this field cannot exceed 4 weeks from the pinned date. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    PinnedNamespaces:
      description: Pinned namespaces view for cluster.
      properties:
        clusterId:
          description: Unique 24-hexadecimal digit string that identifies the request
            cluster.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the request
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        pinnedNamespaces:
          description: List of all pinned namespaces.
          items:
            description: A single pinned namespace.
            readOnly: true
            type: string
          readOnly: true
          type: array
      required:
      - pinnedNamespaces
      type: object
    PipelineRunStats:
      description: Runtime statistics for this Data Lake Pipeline run.
      properties:
        bytesExported:
          description: Total data size in bytes exported for this pipeline run.
          format: int64
          readOnly: true
          type: integer
        numDocs:
          description: Number of docs ingested for a this pipeline run.
          format: int64
          readOnly: true
          type: integer
      readOnly: true
      title: Data Lake Pipeline Run Statistics
      type: object
    PrivateEndpointHostname:
      description: Set of Private endpoint and hostnames.
      properties:
        hostname:
          description: Human-readable label that identifies the hostname.
          readOnly: true
          type: string
        privateEndpoint:
          description: Human-readable label that identifies private endpoint.
          readOnly: true
          type: string
      readOnly: true
      type: object
    PrivateGCPEndpointGroup:
      description: Group of Private Endpoint settings.
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        deleteRequested:
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
          type: boolean
        endpointGroupName:
          description: Human-readable label that identifies a set of endpoints. If
            this private endpoint belongs to a port-mapped endpoint service, this
            field is the private endpoint name.
          externalDocs:
            description: Google Cloud Forwarding Rule Concepts
            url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts
          readOnly: true
          type: string
        endpoints:
          description: List of individual private endpoints that comprise this endpoint
            group. If this endpoint belongs to a port-mapped endpoint service, this
            field will only contain a list of one private endpoint.
          externalDocs:
            description: Google Cloud Forwarding Rule Concepts
            url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts
          items:
            "$ref": "#/components/schemas/GCPConsumerForwardingRule"
          readOnly: true
          type: array
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
        gcpProjectId:
          description: Unique string that identifies the Google Cloud project in which
            you created the endpoints.
          externalDocs:
            description: Google Cloud Creating and Managing Projects
            url: https://cloud.google.com/resource-manager/docs/creating-managing-projects
          readOnly: true
          type: string
        portMappingEnabled:
          description: Flag that indicates whether the endpoint service for this endpoint
            group uses PSC port-mapping.
          type: boolean
        status:
          description: State of the Google Cloud network endpoint group when MongoDB
            Cloud received this request.
          enum:
          - INITIATING
          - VERIFIED
          - AVAILABLE
          - FAILED
          - DELETING
          - DELETED
          readOnly: true
          type: string
      required:
      - cloudProvider
      title: GCP
      type: object
    PrivateIPModeView:
      properties:
        enabled:
          description: Flag that indicates whether someone enabled **Connect via Peering
            Only** mode for the specified project.
          type: boolean
      required:
      - enabled
      type: object
    PrivateLinkEndpoint:
      discriminator:
        mapping:
          AWS: "#/components/schemas/AWSInterfaceEndpoint"
          AZURE: "#/components/schemas/AzurePrivateEndpoint"
          GCP: "#/components/schemas/PrivateGCPEndpointGroup"
        propertyName: cloudProvider
      properties:
        cloudProvider:
          description: Cloud service provider that serves the requested endpoint.
          enum:
          - AWS
          - AZURE
          - GCP
          readOnly: true
          type: string
        deleteRequested:
          description: Flag that indicates whether MongoDB Cloud received a request
            to remove the specified private endpoint from the private endpoint service.
          readOnly: true
          type: boolean
        errorMessage:
          description: Error message returned when requesting private connection resource.
            The resource returns `null` if the request succeeded.
          readOnly: true
          type: string
      required:
      - cloudProvider
      type: object
    PrivateNetworkEndpointIdEntry:
      properties:
        azureLinkId:
          description: Link ID that identifies the Azure private endpoint connection.
          type: string
        comment:
          description: Human-readable string to associate with this private endpoint.
          type: string
        customerEndpointDNSName:
          description: Human-readable label to identify customer's VPC endpoint DNS
            name. If defined, you must also specify a value for `region`.
          type: string
        customerEndpointIPAddress:
          description: IP address used to connect to the Azure private endpoint.
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
        endpointId:
          description: Unique 22-character alphanumeric string that identifies the
            private endpoint.
          example: vpce-3bf78b0ddee411ba1
          externalDocs:
            description: Atlas Data Lake supports Amazon Web Services private endpoints
              using the AWS PrivateLink feature.
            url: https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc
          pattern: "^vpce-[0-9a-f]{17}$"
          type: string
        errorMessage:
          description: Error message describing a failure approving the private endpoint
            request.
          type: string
        provider:
          default: AWS
          description: Human-readable label that identifies the cloud service provider.
            Atlas Data Lake supports Amazon Web Services only.
          enum:
          - AWS
          type: string
        region:
          description: Human-readable label to identify the region of customer's VPC
            endpoint. If defined, you must also specify a value for `customerEndpointDNSName`.
          example: US_EAST_1
          type: string
        status:
          description: Status of the private endpoint connection request.
          enum:
          - PENDING
          - OK
          - FAILED
          - DELETING
          type: string
        type:
          default: DATA_LAKE
          description: Human-readable label that identifies the resource type associated
            with this private endpoint.
          enum:
          - DATA_LAKE
          type: string
      required:
      - endpointId
      type: object
    ProjectSettingItemView:
      properties:
        enabled:
          description: |-
            Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.

            - Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:
              - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.
              - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.

              - You can't disable this setting if you have:
                - more than one private endpoint in more than one region
                - more than one private endpoint in one region and one private endpoint in one or more regions.

            - Set this value to `false` to disable regionalized private endpoints.
          type: boolean
      required:
      - enabled
      type: object
    Prometheus:
      description: Details to integrate one Prometheus account with one MongoDB Cloud
        project.
      properties:
        enabled:
          description: Flag that indicates whether someone has activated the Prometheus
            integration.
          type: boolean
        id:
          description: Integration id.
          nullable: true
          type: string
        password:
          description: Password needed to allow MongoDB Cloud to access your Prometheus
            account.
          type: string
          writeOnly: true
        sendUserProvidedResourceTagsEnabled:
          default: false
          description: Toggle sending user provided group and cluster resource tags
            with the Prometheus metrics.
          type: boolean
        serviceDiscovery:
          description: Desired method to discover the Prometheus service.
          enum:
          - http
          - file
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - PROMETHEUS
          type: string
        username:
          description: Human-readable label that identifies your Prometheus incoming
            webhook.
          example: prom_user_618d48e05277a606ed2496fe
          type: string
      required:
      - enabled
      - serviceDiscovery
      - username
      title: PROMETHEUS
      type: object
    ProtectedHours:
      description: Defines the a window where maintenance will not begin within.
      properties:
        endHourOfDay:
          description: Zero-based integer that represents the end hour of the of the
            day that the maintenance will not begin in.
          format: int32
          maximum: 23
          minimum: 0
          type: integer
        startHourOfDay:
          description: Zero-based integer that represents the beginning hour of the
            of the day that the maintenance will not begin in.
          format: int32
          maximum: 23
          minimum: 0
          type: integer
      type: object
    PublicApiUsageDetailsLineItemView:
      properties:
        billDate:
          description: Billing date of the line item. This parameter expresses its
            value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        clusterName:
          description: Cluster associated with the line item.
          type: string
        description:
          description: Description of the line item, which can include SKU name and
            other identifying information.
          type: string
        groupId:
          description: Group id associated with the line item.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        quantity:
          description: Quantity of line item in units associated with SKU.
          format: double
          readOnly: true
          type: number
        totalPriceCents:
          description: Price * quantity in applicable units, expressed as an integral
            number of cents.
          format: int64
          type: integer
        unitPriceDollars:
          description: Price in units associated with the SKU for the line item.
          format: double
          type: number
        usageDate:
          description: Usage date of the line item. This parameter expresses its value
            in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
      type: object
    PushBasedLogExportProject:
      properties:
        bucketName:
          description: The name of the bucket to which the agent will send the logs
            to.
          type: string
        createDate:
          description: Date and time that this feature was enabled on. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        iamRoleId:
          description: ID of the AWS IAM role that will be used to write to the S3
            bucket.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        prefixPath:
          description: S3 directory in which vector will write to in order to store
            the logs. An empty string denotes the root directory.
          type: string
        state:
          description: Describes whether or not the feature is enabled and what status
            it is in.
          enum:
          - UNCONFIGURED
          - INITIATING
          - BUCKET_VERIFIED
          - BUCKET_VERIFICATION_FAILED
          - ASSUME_ROLE_FAILED
          - ACTIVE
          readOnly: true
          type: string
      type: object
    QueryExecutorScannedObjectsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    QueryExecutorScannedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    QueryShapeResponse:
      description: Response containing the details and status of a query shape. The
        query shape field may be null if the user lacks PII view access.
      properties:
        command:
          description: The MongoDB command type issued for a query shape.
          enum:
          - FIND
          - DISTINCT
          - AGGREGATE
          readOnly: true
          type: string
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          readOnly: true
          type: string
        queryShape:
          description: A query shape is a set of specifications that group similar
            queries together. Specifications can include filters, sorts, projections,
            aggregation pipeline stages, a namespace, and others. Queries that have
            similar specifications have the same query shape. This field may be null
            if the user lacks PII view access.
          readOnly: true
          type: string
        queryShapeHash:
          description: A hexadecimal string that represents the hash of a MongoDB
            query shape.
          readOnly: true
          type: string
        status:
          description: The rejection status of a query shape. Use REJECTED to prevent
            the query shape from executing on the cluster, or UNREJECTED to allow
            it to execute.
          enum:
          - REJECTED
          - UNREJECTED
          type: string
      required:
      - queryShapeHash
      - status
      type: object
    QueryShapeSeenMetadata:
      description: Metadata about when a query shape was seen.
      properties:
        applicationName:
          description: The name of the application that this query shape came from.
            This can be set via the MongoDB connection string. The application name
            is set to unknown for internal MongoDB queries.
          type: string
        driverName:
          description: The name of the MongoDB driver that this query shape was executed
            from. The driver name is set to unknown for internal MongoDB queries.
          type: string
        driverVersion:
          description: The version of the MongoDB driver that this query shape was
            executed from. The driver version is set to unknown for internal MongoDB
            queries.
          type: string
        timestamp:
          description: Unix epoch milliseconds of the time.
          format: int64
          type: integer
      type: object
    QueryShapeUpdateRequest:
      description: Request body for modifying the rejection status of a query shape.
      properties:
        status:
          description: The rejection status of a query shape. Use REJECTED to prevent
            the query shape from executing on the cluster, or UNREJECTED to allow
            it to execute.
          enum:
          - REJECTED
          - UNREJECTED
          type: string
      required:
      - status
      type: object
    QuerySpillToDiskDuringSortRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    QueryStatsDetailsResponse:
      description: Metadata and summary statistics for a given query shape.
      properties:
        firstSeen:
          "$ref": "#/components/schemas/QueryShapeSeenMetadata"
        lastSeen:
          "$ref": "#/components/schemas/QueryShapeSeenMetadata"
        queryStats:
          "$ref": "#/components/schemas/QueryStatsSummary"
      type: object
    QueryStatsSummary:
      description: A summary of execution statistics for a given query shape.
      properties:
        avgWorkingMillis:
          description: Average total time in milliseconds spent running queries with
            the given query shape. If the query resulted in `getMore` commands, this
            metric includes the time spent processing the `getMore` requests. This
            metric does not include time spent waiting for the client.
          format: double
          type: number
        bytesRead:
          description: The number of bytes read by the given query shape from the
            disk to the cache.
          format: double
          type: number
        command:
          description: The MongoDB command issued for this query shape.
          enum:
          - find
          - distinct
          - aggregate
          type: string
        cpuTime:
          description: Total CPU time in nanoseconds consumed by queries with the
            given query shape. Available for MDB 8.2 and higher.
          format: double
          nullable: true
          type: number
        docsExamined:
          description: Total number of documents examined by queries with the given
            query shape.
          format: double
          type: number
        docsExaminedRatio:
          description: Ratio of documents examined to documents returned by queries
            with the given query shape.
          format: double
          type: number
        docsReturned:
          description: Total number of documents returned by queries with the given
            query shape.
          format: double
          type: number
        execCount:
          description: Total number of times that queries with the given query shape
            have been executed.
          format: double
          type: number
        keysExamined:
          description: Total number of in-bounds and out-of-bounds index keys examined
            by queries with the given query shape.
          format: double
          type: number
        keysExaminedRatio:
          description: Ratio of in-bounds and out-of-bounds index keys examined to
            indexes containing documents returned by queries with the given query
            shape.
          format: double
          type: number
        lastExecMicros:
          description: Execution runtime in microseconds for the most recent query
            with the given query shape.
          format: double
          type: number
        namespace:
          description: Human-readable label that identifies the namespace on the specified
            host. The resource expresses this parameter value as `<database>.<collection>`.
          type: string
        p50ExecMicros:
          description: The 50th percentile value of execution time in microseconds.
          format: double
          type: number
        p90ExecMicros:
          description: The 90th percentile value of execution time in microseconds.
          format: double
          type: number
        p99ExecMicros:
          description: The 99th percentile value of execution time in microseconds.
          format: double
          type: number
        queryShape:
          description: A query shape is a set of specifications that group similar
            queries together. Specifications can include filters, sorts, projections,
            aggregation pipeline stages, a namespace, and others. Queries that have
            similar specifications have the same query shape.
          type: string
        queryShapeHash:
          description: A hexadecimal string that represents the hash of a MongoDB
            query shape.
          type: string
        systemQuery:
          description: Indicates whether this query shape represents a system-initiated
            query.
          type: boolean
        totalTimeToResponseMicros:
          description: Time in microseconds spent from the beginning of query processing
            to the first server response.
          format: double
          type: number
        totalWorkingMillis:
          description: Total time in milliseconds spent running queries with the given
            query shape. If the query resulted in `getMore` commands, this metric
            includes the time spent processing the `getMore` requests. This metric
            does not include time spent waiting for the client.
          format: double
          type: number
      type: object
    QueryStatsSummaryListResponse:
      properties:
        summaries:
          description: List of query shape statistic summaries from Query Shape Insights.
          items:
            "$ref": "#/components/schemas/QueryStatsSummary"
          type: array
      type: object
    QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    QueryTargetingScannedPerReturnedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    RPUMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/ServerlessMetricUnits"
      required:
      - metricName
      type: object
    RateLimitEndpointSetCapacity:
      description: The rate limit capacity for the endpoint set.
      properties:
        defaultValue:
          description: The default request capacity of the endpoint set. Returned
            if there is a capacity override set for the requested entity.
          format: int64
          type: integer
        value:
          description: The applied request capacity of the endpoint set.
          format: int64
          type: integer
      type: object
    RateLimitEndpointSetEndpoint:
      properties:
        method:
          description: The HTTP method of the endpoint.
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          type: string
        path:
          description: The URL path of the endpoint.
          example: "/api/atlas/v2/rateLimits"
          type: string
      type: object
    RateLimitEndpointSetRefillDurationSeconds:
      description: The rate limit refill duration for the endpoint set.
      properties:
        defaultValue:
          description: The default rate limit refill duration, in seconds, of the
            endpoint set. Returned if there is a rate limit refill duration override
            set for the requested entity.
          format: int64
          type: integer
        value:
          description: The applied rate limit refill duration of the endpoint set.
          format: int64
          type: integer
      type: object
    RateLimitEndpointSetRefillRate:
      description: The rate limit refill rate for the endpoint set.
      properties:
        defaultValue:
          description: The default rate limit refill rate of the endpoint set. Returned
            if there is a rate limit refill rate override set for the requested entity.
          format: int64
          type: integer
        value:
          description: The applied rate limit refill rate of the endpoint set.
          format: int64
          type: integer
      type: object
    RateLimitEndpointSetResponse:
      properties:
        capacity:
          "$ref": "#/components/schemas/RateLimitEndpointSetCapacity"
        endpointSetId:
          description: The ID of the endpoint set.
          example: rateLimitsInspection_group
          type: string
        endpointSetName:
          description: The endpoint set name.
          example: Rate Limits Inspection
          type: string
        endpoints:
          description: A list of endpoints associated with the specified endpoint
            set.
          items:
            "$ref": "#/components/schemas/RateLimitEndpointSetEndpoint"
          maxItems: 100
          type: array
          uniqueItems: true
        refillDurationSeconds:
          "$ref": "#/components/schemas/RateLimitEndpointSetRefillDurationSeconds"
        refillRate:
          "$ref": "#/components/schemas/RateLimitEndpointSetRefillRate"
        scope:
          description: The scope of the endpoint set.
          enum:
          - IP
          - GROUP
          - ORGANIZATION
          - USER
          type: string
      type: object
    RawMetricAlertView:
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/RawMetricValueView"
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: |-
            Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.

            To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.

            **NOTE**: If you set `eventTypeName` to `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
          example: ASSERT_USER
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      type: object
    RawMetricEventView:
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/RawMetricValueView"
        deskLocation:
          description: Desk location of MongoDB employee associated with the event.
          readOnly: true
          type: string
        employeeIdentifier:
          description: Identifier of MongoDB employee associated with the event.
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: Human-readable label of the metric associated with the `alertId`.
            This field may change type of `currentValue` field.
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      type: object
    RawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    RawMetricUnits:
      default: RAW
      description: Element used to express the quantity. This can be an element of
        time, storage capacity, and the like.
      enum:
      - RAW
      title: Raw Metric Units
      type: string
    RawMetricValueView:
      description: Measurement of the `metricName` recorded at the time of the event.
      properties:
        number:
          description: Amount of the `metricName` recorded at the time of the event.
            This value triggered the alert.
          format: double
          readOnly: true
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      readOnly: true
      title: Raw Metric Value
      type: object
    RegionSpec:
      description: Physical location where MongoDB Cloud provisions cluster nodes.
      properties:
        analyticsNodes:
          description: Number of analytics nodes in the region. Analytics nodes handle
            analytic data such as reporting queries from MongoDB Connector for Business
            Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can
            never become the primary. Use `replicationSpecs[n].{region}.analyticsNodes`
            instead.
          format: int32
          type: integer
        electableNodes:
          description: Number of electable nodes to deploy in the specified region.
            Electable nodes can become the primary and can facilitate local reads.
            Use `replicationSpecs[n].{region}.electableNodes` instead.
          enum:
          - 0
          - 3
          - 5
          - 7
          format: int32
          type: integer
        priority:
          description: Number that indicates the election priority of the region.
            To identify the Preferred Region of the cluster, set this parameter to
            `7`. The primary node runs in the **Preferred Region**. To identify a
            read-only region, set this parameter to `0`.
          format: int32
          maximum: 7
          minimum: 0
          type: integer
        readOnlyNodes:
          description: Number of read-only nodes in the region. Read-only nodes can
            never become the primary member, but can facilitate local reads. Use `replicationSpecs[n].{region}.readOnlyNodes`
            instead.
          format: int32
          type: integer
      title: Region Configuration
      type: object
    ReplicaSetAlertConfigViewForNdsGroup:
      description: Replica Set alert configuration allows to select which conditions
        of mongod replica set trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/ReplicaSetMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/AlertsThresholdInteger"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Replica Set Alert Configuration
      type: object
    ReplicaSetAlertViewForNdsGroup:
      description: Replica Set alert notifies about different activities on replica
        set of mongod instances.
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        nonRunningHostIds:
          description: List of unique 24-hexadecimal character strings that identify
            the replica set members that are not in PRIMARY nor SECONDARY state.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{8,32})$"
            type: string
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        parentClusterId:
          description: Unique 24-hexadecimal character string that identifies the
            parent cluster to which this alert applies. The parent cluster contains
            the sharded nodes. MongoDB Cloud returns this parameter only for alerts
            of events impacting sharded clusters.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: ReplicaSet Alerts
      type: object
    ReplicaSetEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - PRIMARY_ELECTED
      - REPLICATION_OPLOG_WINDOW_HEALTHY
      - REPLICATION_OPLOG_WINDOW_RUNNING_OUT
      - ONE_PRIMARY
      - NO_PRIMARY
      - TOO_MANY_ELECTIONS
      - TOO_FEW_HEALTHY_MEMBERS
      - TOO_MANY_UNHEALTHY_MEMBERS
      example: PRIMARY_ELECTED
      title: ReplicaSet Event Types
      type: string
    ReplicaSetEventTypeViewForNdsGroupAlertable:
      description: Incident that triggered this alert.
      enum:
      - REPLICATION_OPLOG_WINDOW_RUNNING_OUT
      - NO_PRIMARY
      - PRIMARY_ELECTED
      - TOO_MANY_ELECTIONS
      - TOO_FEW_HEALTHY_MEMBERS
      - TOO_MANY_UNHEALTHY_MEMBERS
      example: NO_PRIMARY
      readOnly: true
      title: ReplicaSet Event Types
      type: string
    ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold:
      description: Event type that triggers an alert.
      enum:
      - NO_PRIMARY
      - PRIMARY_ELECTED
      example: NO_PRIMARY
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: ReplicaSet Event Types
      type: string
    ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold:
      description: Event type that triggers an alert.
      enum:
      - TOO_MANY_ELECTIONS
      - REPLICATION_OPLOG_WINDOW_RUNNING_OUT
      - TOO_FEW_HEALTHY_MEMBERS
      - TOO_MANY_UNHEALTHY_MEMBERS
      example: TOO_MANY_ELECTIONS
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: ReplicaSet Event Types
      type: string
    ReplicaSetMatcher:
      description: Rules to apply when comparing an replica set against this alert
        configuration.
      properties:
        fieldName:
          "$ref": "#/components/schemas/ReplicaSetMatcherField"
        operator:
          description: Comparison operator to apply when checking the current metric
            value against **matcher[n].value**. The `REGEX` operator only supports
            inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
          type: string
        value:
          description: Value to match or exceed using the specified `matchers.operator`.
          example: event-replica-set
          type: string
      required:
      - fieldName
      - operator
      - value
      title: Matchers
      type: object
    ReplicaSetMatcherField:
      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:
      - REPLICA_SET_NAME
      - SHARD_NAME
      - CLUSTER_NAME
      example: REPLICA_SET_NAME
      title: Replica Set Matcher Fields
      type: string
    ReplicaSetThresholdAlertConfigViewForNdsGroup:
      description: Replica Set threshold alert configuration allows to select thresholds
        for conditions of mongod replica set which trigger alerts and how users are
        notified.
      discriminator:
        mapping:
          REPLICATION_OPLOG_WINDOW_RUNNING_OUT: "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup"
          TOO_MANY_ELECTIONS: "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup"
        propertyName: eventTypeName
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          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/ReplicaSetMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/AlertsThresholdInteger"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Replica Set Threshold Alert Configuration
      type: object
    ReplicationSpec20240805:
      description: Details that explain how MongoDB Cloud replicates data on the specified
        MongoDB database.
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies the replication
            object for a shard in a Cluster. If you include existing shard replication
            configurations in the request, you must specify this parameter. If you
            add a new shard to an existing Cluster, you may specify this parameter.
            The request deletes any existing shards  in the Cluster that you exclude
            from the request. This corresponds to Shard ID displayed in the UI.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        regionConfigs:
          description: |-
            Hardware specifications for nodes set for a given region. Each `regionConfigs` object must be unique by region and cloud provider within the `replicationSpec`. Each `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. Tenant clusters only require `electableSpecs`. Dedicated clusters can specify any of these specifications, but must have at least one `electableSpecs` object within a `replicationSpec`.

            **Example:**

            If you set `replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize` : `M30`, set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` : `M30` if you have electable nodes and `replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize` : `M30` if you have read-only nodes.
          items:
            "$ref": "#/components/schemas/CloudRegionConfig20240805"
          type: array
        zoneId:
          description: Unique 24-hexadecimal digit string that identifies the zone
            in a Global Cluster. This value can be used to configure Global Cluster
            backup policies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        zoneName:
          description: 'Human-readable label that describes the zone this shard belongs
            to in a Global Cluster. Provide this value only if `clusterType` : `GEOSHARDED`
            but not `selfManagedSharding` : `true`.'
          type: string
      title: Replication Specifications
      type: object
    RequestAccepted:
      description: Accepted.
      type: object
    ResourceEventTypeView:
      description: Unique identifier of event type.
      enum:
      - TAGS_MODIFIED
      - CLUSTER_TAGS_MODIFIED
      - GROUP_TAGS_MODIFIED
      example: TAGS_MODIFIED
      title: Resource Event Types
      type: string
    ResourceEventTypeViewForOrg:
      description: Unique identifier of event type.
      enum:
      - TAGS_MODIFIED
      - GROUP_TAGS_MODIFIED
      example: GROUP_TAGS_MODIFIED
      title: Resource Event Types
      type: string
    ResourceEventViewForNdsGroup:
      description: Resource event reflects different activities about resources.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ResourceEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        resourceId:
          description: Unique 24-hexadecimal digit string that identifies the resource
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resourceType:
          description: Unique identifier of resource type.
          example: cluster
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      - resourceType
      title: Resource Events
      type: object
    ResourceEventViewForOrg:
      description: Resource event reflects different activities about resources.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ResourceEventTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        resourceId:
          description: Unique 24-hexadecimal digit string that identifies the resource
            associated with the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        resourceType:
          description: Unique identifier of resource type.
          example: cluster
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      - resourceType
      title: Resource Events
      type: object
    ResourceTag:
      description: 'Key-value pair that tags and categorizes a MongoDB Cloud organization,
        project, or cluster. For example, `environment : production`.'
      properties:
        key:
          description: 'Constant that defines the set of the tag. For example, `environment`
            in the `environment : production` tag.'
          maxLength: 255
          minLength: 1
          type: string
        value:
          description: 'Variable that belongs to the set of the tag. For example,
            `production` in the `environment : production` tag.'
          maxLength: 255
          minLength: 1
          type: string
      required:
      - key
      - value
      title: Resource Tag
      type: object
    RestartsInLastHourRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    RestoreJobFileHash:
      description: Key and value pair that map one restore file to one hashed checksum.
        This parameter applies after you download the corresponding `delivery.url`.
      properties:
        fileName:
          description: Human-readable label that identifies the hashed file.
          readOnly: true
          type: string
        hash:
          description: Hashed checksum that maps to the restore file.
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        typeName:
          description: Human-readable label that identifies the hashing algorithm
            used to compute the hash value.
          enum:
          - SHA1
          readOnly: true
          type: string
      readOnly: true
      type: object
    S3LogIntegrationRequest:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationRequest"
      - properties:
          bucketName:
            description: Name of the bucket to store log files.
            example: my-log-bucket
            type: string
          iamRoleId:
            description: Unique 24-character hexadecimal string that identifies the
              AWS IAM role that Atlas uses to access the S3 bucket.
            example: 507f1f77bcf86cd799439011
            pattern: "^[a-fA-F0-9]{24}$"
            type: string
          kmsKey:
            description: AWS KMS key ID or ARN for server-side encryption (optional).
              If not provided, uses bucket default encryption settings.
            example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
            nullable: true
            type: string
          prefixPath:
            description: Path prefix where the log files will be stored. Atlas will
              add further sub-directories based on the log type.
            example: mongo-logs/
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - S3_LOG_EXPORT
            type: string
          useLegacyPathStructure:
            description: 'When true, uses the legacy daily-folder path structure compatible
              with Push-Based Log Export: `{prefix}/{cluster}/{hostname}/{logType}/{YYYY-MM-DD}/{timestamp}-{logType}.log`.
              When false (default), uses the flat timestamped structure: `{prefix}/{cluster}/{hostname}/{logType}/{timestamp}-{logType}.log`.'
            nullable: true
            type: boolean
        type: object
      description: Request schema for creating or updating an S3 log export integration.
      required:
      - bucketName
      - iamRoleId
      - logTypes
      - prefixPath
      - type
      title: S3 Log Export Integration Request
      type: object
    S3LogIntegrationResponse:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationResponse"
      - properties:
          bucketName:
            description: Name of the bucket to store log files.
            example: my-log-bucket
            type: string
          iamRoleId:
            description: Unique 24-character hexadecimal string that identifies the
              AWS IAM role that Atlas uses to access the S3 bucket.
            example: 507f1f77bcf86cd799439011
            pattern: "^[a-fA-F0-9]{24}$"
            type: string
          kmsKey:
            description: AWS KMS key ID or ARN for server-side encryption (optional).
              If not provided, uses bucket default encryption settings.
            example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
            nullable: true
            type: string
          prefixPath:
            description: Path prefix where the log files will be stored. Atlas will
              add further sub-directories based on the log type.
            example: mongo-logs/
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - S3_LOG_EXPORT
            type: string
          useLegacyPathStructure:
            description: 'When true, uses the legacy daily-folder path structure compatible
              with Push-Based Log Export: `{prefix}/{cluster}/{hostname}/{logType}/{YYYY-MM-DD}/{timestamp}-{logType}.log`.
              When false (default), uses the flat timestamped structure: `{prefix}/{cluster}/{hostname}/{logType}/{timestamp}-{logType}.log`.'
            nullable: true
            type: boolean
        type: object
      description: Details to integrate S3 log export with one Atlas project.
      required:
      - bucketName
      - iamRoleId
      - id
      - logTypes
      - prefixPath
      - type
      title: S3 Log Export Integration Response
      type: object
    SMSNotification:
      description: SMS notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        mobileNumber:
          description: 'Mobile phone number to which MongoDB Cloud sends alert notifications.
            The resource requires this parameter when `"notifications.[n].typeName"
            : "SMS"`.'
          example: '1233337892'
          type: string
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - SMS
          type: string
      required:
      - typeName
      title: SMS Notification
      type: object
    SampleDatasetStatus:
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies this
            sample dataset.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster into which
            you loaded the sample dataset.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        completeDate:
          description: Date and time when the sample dataset load job completed. MongoDB
            Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        createDate:
          description: Date and time when you started the sample dataset load job.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        errorMessage:
          description: Details of the error returned when MongoDB Cloud loads the
            sample dataset. This endpoint returns null if state has a value other
            than FAILED.
          readOnly: true
          type: string
        state:
          description: Status of the sample dataset load job.
          enum:
          - WORKING
          - FAILED
          - COMPLETED
          readOnly: true
          type: string
      type: object
    SchemaAdvisorItemRecommendation:
      properties:
        affectedNamespaces:
          description: List that contains the namespaces and information on why those
            namespaces triggered the recommendation.
          items:
            "$ref": "#/components/schemas/SchemaAdvisorNamespaceTriggers"
          readOnly: true
          type: array
        description:
          description: Description of the specified recommendation.
          readOnly: true
          type: string
        recommendation:
          description: Type of recommendation.
          enum:
          - REDUCE_LOOKUP_OPS
          - AVOID_UNBOUNDED_ARRAY
          - REDUCE_DOCUMENT_SIZE
          - REMOVE_UNNECESSARY_INDEXES
          - REDUCE_NUMBER_OF_NAMESPACES
          - OPTIMIZE_CASE_INSENSITIVE_REGEX_QUERIES
          - OPTIMIZE_TEXT_QUERIES
          readOnly: true
          type: string
      type: object
    SchemaAdvisorNamespaceTriggers:
      properties:
        namespace:
          description: Namespace of the affected collection. Will be null for `REDUCE_NUMBER_OF_NAMESPACE`
            recommendation.
          nullable: true
          readOnly: true
          type: string
        triggers:
          description: List of triggers that specify why the collection activated
            the recommendation.
          items:
            "$ref": "#/components/schemas/SchemaAdvisorTriggerDetails"
          readOnly: true
          type: array
      type: object
    SchemaAdvisorResponse:
      properties:
        recommendations:
          description: List that contains the documents with information about the
            schema advice that Performance Advisor suggests.
          items:
            "$ref": "#/components/schemas/SchemaAdvisorItemRecommendation"
          readOnly: true
          type: array
      type: object
    SchemaAdvisorTriggerDetails:
      properties:
        description:
          description: Description of the trigger type.
          readOnly: true
          type: string
        triggerType:
          description: Type of trigger.
          enum:
          - PERCENT_QUERIES_USE_LOOKUP
          - NUMBER_OF_QUERIES_USE_LOOKUP
          - DOCS_CONTAIN_UNBOUNDED_ARRAY
          - NUMBER_OF_NAMESPACES
          - DOC_SIZE_TOO_LARGE
          - NUM_INDEXES
          - QUERIES_CONTAIN_CASE_INSENSITIVE_REGEX
          readOnly: true
          type: string
      type: object
    SchemaRegistryAuthentication:
      description: Authentication configuration for Schema Registry.
      discriminator:
        mapping:
          SASL_INHERIT: "#/components/schemas/ConfluentSaslInheritAuthentication"
          USER_INFO: "#/components/schemas/ConfluentUserInfoAuthentication"
        propertyName: type
      oneOf:
      - "$ref": "#/components/schemas/ConfluentUserInfoAuthentication"
      - "$ref": "#/components/schemas/ConfluentSaslInheritAuthentication"
      properties:
        type:
          description: Authentication type discriminator. Specifies the authentication
            mechanism for Confluent Schema Registry.
          enum:
          - USER_INFO
          - SASL_INHERIT
          type: string
      required:
      - type
      type: object
    SearchDeploymentAuditTypeView:
      description: Unique identifier of event type.
      enum:
      - SEARCH_DEPLOYMENT_CREATED
      - SEARCH_DEPLOYMENT_UPDATED
      - SEARCH_DEPLOYMENT_DELETED
      example: SEARCH_DEPLOYMENT_CREATED
      title: Search Deployment Audit Types
      type: string
    SearchDeploymentAuditView:
      description: Indicates activities on decoupled search nodes.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/SearchDeploymentAuditTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Search Deployment Audits
      type: object
    SearchHostStatusDetail:
      properties:
        hostname:
          description: Hostname that corresponds to the status detail.
          type: string
        mainIndex:
          "$ref": "#/components/schemas/SearchMainIndexStatusDetail"
        queryable:
          description: Flag that indicates whether the index is queryable on the host.
          type: boolean
        stagedIndex:
          "$ref": "#/components/schemas/SearchStagedIndexStatusDetail"
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
      title: Search Host Status Detail
      type: object
    SearchIndex:
      allOf:
      - "$ref": "#/components/schemas/ClusterSearchIndex"
      - properties:
          analyzer:
            default: lucene.standard
            description: |-
              Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:

              - extracting words
              - removing punctuation
              - removing accents
              - changing to lowercase
              - removing common words
              - reducing words to their root form (stemming)
              - changing words to their base form (lemmatization)
               MongoDB Cloud uses the selected process to build the Atlas Search index.
            enum:
            - lucene.standard
            - lucene.simple
            - lucene.whitespace
            - lucene.keyword
            - lucene.arabic
            - lucene.armenian
            - lucene.basque
            - lucene.bengali
            - lucene.brazilian
            - lucene.bulgarian
            - lucene.catalan
            - lucene.chinese
            - lucene.cjk
            - lucene.czech
            - lucene.danish
            - lucene.dutch
            - lucene.english
            - lucene.finnish
            - lucene.french
            - lucene.galician
            - lucene.german
            - lucene.greek
            - lucene.hindi
            - lucene.hungarian
            - lucene.indonesian
            - lucene.irish
            - lucene.italian
            - lucene.japanese
            - lucene.korean
            - lucene.kuromoji
            - lucene.latvian
            - lucene.lithuanian
            - lucene.morfologik
            - lucene.nori
            - lucene.norwegian
            - lucene.persian
            - lucene.portuguese
            - lucene.romanian
            - lucene.russian
            - lucene.smartcn
            - lucene.sorani
            - lucene.spanish
            - lucene.swedish
            - lucene.thai
            - lucene.turkish
            - lucene.ukrainian
            externalDocs:
              description: Atlas Search Analyzers
              url: https://dochub.mongodb.org/core/analyzers--fts
            type: string
          analyzers:
            description: List of user-defined methods to convert database field text
              into searchable words.
            externalDocs:
              description: Custom Atlas Search Analyzers
              url: https://dochub.mongodb.org/core/custom-fts
            items:
              "$ref": "#/components/schemas/ApiAtlasFTSAnalyzersViewManual"
            type: array
          mappings:
            "$ref": "#/components/schemas/ApiAtlasFTSMappingsViewManual"
          searchAnalyzer:
            default: lucene.standard
            description: Method applied to identify words when searching this index.
            enum:
            - lucene.standard
            - lucene.simple
            - lucene.whitespace
            - lucene.keyword
            - lucene.arabic
            - lucene.armenian
            - lucene.basque
            - lucene.bengali
            - lucene.brazilian
            - lucene.bulgarian
            - lucene.catalan
            - lucene.chinese
            - lucene.cjk
            - lucene.czech
            - lucene.danish
            - lucene.dutch
            - lucene.english
            - lucene.finnish
            - lucene.french
            - lucene.galician
            - lucene.german
            - lucene.greek
            - lucene.hindi
            - lucene.hungarian
            - lucene.indonesian
            - lucene.irish
            - lucene.italian
            - lucene.japanese
            - lucene.korean
            - lucene.kuromoji
            - lucene.latvian
            - lucene.lithuanian
            - lucene.morfologik
            - lucene.nori
            - lucene.norwegian
            - lucene.persian
            - lucene.portuguese
            - lucene.romanian
            - lucene.russian
            - lucene.smartcn
            - lucene.sorani
            - lucene.spanish
            - lucene.swedish
            - lucene.thai
            - lucene.turkish
            - lucene.ukrainian
            type: string
          synonyms:
            description: Rule sets that map words to their synonyms in this index.
            externalDocs:
              description: Synonym Mapping
              url: https://dochub.mongodb.org/core/fts-synonym-mappings
            items:
              "$ref": "#/components/schemas/SearchSynonymMappingDefinition"
            type: array
        type: object
      required:
      - collectionName
      - database
      - name
      type: object
    SearchIndexCreateRequest:
      discriminator:
        mapping:
          search: "#/components/schemas/TextSearchIndexCreateRequest"
          vectorSearch: "#/components/schemas/VectorSearchIndexCreateRequest"
        propertyName: type
      properties:
        collectionName:
          description: Label that identifies the collection to create an Atlas Search
            index in.
          type: string
        database:
          description: Label that identifies the database that contains the collection
            to create an Atlas Search index in.
          type: string
        name:
          description: Label that identifies this index. Within each namespace, names
            of all indexes in the namespace must be unique.
          type: string
        type:
          description: Type of the index. The default type is search.
          enum:
          - search
          - vectorSearch
          type: string
      required:
      - collectionName
      - database
      - name
      type: object
    SearchIndexDefinition:
      description: The search index definition set by the user.
      properties:
        numPartitions:
          default: 1
          description: Number of index partitions. Allowed values are [1, 2, 4].
          format: int32
          type: integer
        storedSource:
          description: Flag that indicates whether to store all fields (true) on Atlas
            Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively,
            you can specify an object that only contains the list of fields to store
            (include) or not store (exclude) on Atlas Search. Note that storing all
            fields (true) is not allowed for vector search indexes. To learn more,
            see Stored Source Fields.
          example:
            include | exclude:
            - field1
            - field2
          externalDocs:
            description: Stored Source Fields
            url: https://dochub.mongodb.org/core/atlas-search-stored-source
          type: object
      title: Search Index Definition
      type: object
    SearchIndexDefinitionVersion:
      description: Object which includes the version number of the index definition
        and the time that the index definition was created.
      properties:
        createdAt:
          description: The time at which this index definition was created. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        version:
          description: The version number associated with this index definition when
            it was created.
          format: int64
          type: integer
      title: Search Index Definition Version
      type: object
    SearchIndexResponse:
      discriminator:
        mapping:
          search: "#/components/schemas/TextSearchIndexResponse"
          vectorSearch: "#/components/schemas/VectorSearchIndexResponse"
        propertyName: type
      properties:
        collectionName:
          description: Label that identifies the collection that contains one or more
            Atlas Search indexes.
          type: string
        database:
          description: Label that identifies the database that contains the collection
            with one or more Atlas Search indexes.
          type: string
        indexID:
          description: Unique 24-hexadecimal digit string that identifies this Atlas
            Search index.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        latestDefinition:
          "$ref": "#/components/schemas/SearchIndexDefinition"
        latestDefinitionVersion:
          "$ref": "#/components/schemas/SearchIndexDefinitionVersion"
        name:
          description: Label that identifies this index. Within each namespace, the
            names of all indexes must be unique.
          type: string
        queryable:
          description: Flag that indicates whether the index is queryable on all hosts.
          type: boolean
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
        statusDetail:
          description: List of documents detailing index status on each host.
          items:
            "$ref": "#/components/schemas/SearchHostStatusDetail"
          type: array
        type:
          description: Type of the index. The default type is search.
          enum:
          - search
          - vectorSearch
          type: string
      title: Search Index Response
      type: object
    SearchIndexSizeDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SearchIndexUpdateRequest:
      properties:
        definition:
          description: The index definition to update the search index to.
          oneOf:
          - "$ref": "#/components/schemas/TextSearchIndexDefinition"
          - "$ref": "#/components/schemas/VectorSearchIndexDefinition"
          type: object
      required:
      - definition
      title: Search Index Update Request
      type: object
    SearchMainIndexStatusDetail:
      description: Contains status information about the active index.
      properties:
        definition:
          "$ref": "#/components/schemas/SearchIndexDefinition"
        definitionVersion:
          "$ref": "#/components/schemas/SearchIndexDefinitionVersion"
        message:
          description: Optional message describing an error.
          type: string
        queryable:
          description: Flag that indicates whether the index generation is queryable
            on the host.
          type: boolean
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
      title: Search Main Index Status Detail
      type: object
    SearchMappings:
      description: Index specifications for the collection's fields.
      properties:
        dynamic:
          description: Indicates whether the index uses static, default dynamic, or
            configurable dynamic mappings. Set to `true` to enable dynamic mapping
            with default type set or define object to specify the name of the configured
            type sets for dynamic mapping. If you specify configurable dynamic mappings,
            you must define the referred type sets in the `typeSets` field. Set to
            `false` to use only static mappings through `mappings.fields`.
          example:
            typeSet: typeSet1
          externalDocs:
            description: Static, Dynamic or Configurable Dynamic Mappings
            url: https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings
          type: object
        fields:
          additionalProperties:
            "$ref": "#/components/schemas/Fields"
          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://dochub.mongodb.org/core/index-definitions-fts
          type: object
          x-additionalPropertiesName: Field Name
      title: Mappings
      type: object
    SearchMaxFieldsIndexedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchMaxNgramFieldsIndexedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchNumberOfFieldsInIndexRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchNumberOfQueriesErrorRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchNumberOfQueriesSuccessRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchNumberOfQueriesTotalRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchOpCounterDeleteRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchOpCounterGetMoreRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchOpCounterInsertRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchOpCounterUpdateRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchProcessThrottlingRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SearchReplicationLagTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    SearchStagedIndexStatusDetail:
      description: Contains status information about an index building in the background.
      properties:
        definition:
          "$ref": "#/components/schemas/SearchIndexDefinition"
        definitionVersion:
          "$ref": "#/components/schemas/SearchIndexDefinitionVersion"
        message:
          description: Optional message describing an error.
          type: string
        queryable:
          description: Flag that indicates whether the index generation is queryable
            on the host.
          type: boolean
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
      title: Search Staged Index Status Detail
      type: object
    SearchSynonymMappingDefinition:
      description: Synonyms used for this full text index.
      properties:
        analyzer:
          description: Specific pre-defined method chosen to apply to the synonyms
            to be searched.
          enum:
          - lucene.standard
          - lucene.simple
          - lucene.whitespace
          - lucene.keyword
          - lucene.arabic
          - lucene.armenian
          - lucene.basque
          - lucene.bengali
          - lucene.brazilian
          - lucene.bulgarian
          - lucene.catalan
          - lucene.chinese
          - lucene.cjk
          - lucene.czech
          - lucene.danish
          - lucene.dutch
          - lucene.english
          - lucene.finnish
          - lucene.french
          - lucene.galician
          - lucene.german
          - lucene.greek
          - lucene.hindi
          - lucene.hungarian
          - lucene.indonesian
          - lucene.irish
          - lucene.italian
          - lucene.japanese
          - lucene.korean
          - lucene.kuromoji
          - lucene.latvian
          - lucene.lithuanian
          - lucene.morfologik
          - lucene.nori
          - lucene.norwegian
          - lucene.persian
          - lucene.portuguese
          - lucene.romanian
          - lucene.russian
          - lucene.smartcn
          - lucene.sorani
          - lucene.spanish
          - lucene.swedish
          - lucene.thai
          - lucene.turkish
          - lucene.ukrainian
          type: string
        name:
          description: Label that identifies the synonym definition. Each `synonym.name`
            must be unique within the same index definition.
          type: string
        source:
          "$ref": "#/components/schemas/SynonymSource"
      required:
      - analyzer
      - name
      - source
      title: Synonym Mapping Definition
      type: object
    SearchTypeSets:
      description: Type sets for an Atlas Search index definition.
      externalDocs:
        description: Type Sets
        url: https://dochub.mongodb.org/core/atlas-search-configure-dynamic-indexing
      properties:
        name:
          description: Label that identifies the type set name. Each `typeSets.name`
            must be unique within the same index definition.
          type: string
        types:
          description: List of types associated with the type set. Each type definition
            must include a `type` field specifying the search field type (`autocomplete`,
            `boolean`, `date`, `geo`, `number`, `objectId`, `string`, `token`, or
            `uuid`) and may include additional configuration properties specific to
            that type.
          items:
            "$ref": "#/components/schemas/BasicDBObject"
          maxItems: 100
          type: array
      required:
      - name
      - types
      title: TypeSets
      type: object
    ServerlessAVGCommandExecutionTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    ServerlessAVGWriteExecutionTimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    ServerlessAWSTenantEndpoint:
      description: View for a serverless AWS tenant endpoint.
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the private
            endpoint.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        cloudProviderEndpointId:
          description: Unique string that identifies the private endpoint's network
            interface.
          pattern: "^vpce-[0-9a-f]{17}$"
          readOnly: true
          type: string
        comment:
          description: Human-readable comment associated with the private endpoint.
          maxLength: 80
          readOnly: true
          type: string
        endpointServiceName:
          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
          type: string
        errorMessage:
          description: Human-readable error message that indicates error condition
            associated with establishing the private endpoint connection.
          readOnly: true
          type: string
        providerName:
          description: Human-readable label that identifies the cloud service provider.
          enum:
          - AWS
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the current operating status
            of the private endpoint.
          enum:
          - RESERVATION_REQUESTED
          - RESERVED
          - INITIATING
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
          type: string
      title: AWS
      type: object
    ServerlessAWSTenantEndpointUpdate:
      allOf:
      - "$ref": "#/components/schemas/ServerlessTenantEndpointUpdate"
      - properties:
          cloudProviderEndpointId:
            description: Unique string that identifies the private endpoint's network
              interface.
            pattern: "^vpce-[0-9a-f]{17}$"
            type: string
            writeOnly: true
        type: object
      description: Updates to a serverless AWS tenant endpoint.
      required:
      - providerName
      title: AWS
      type: object
    ServerlessAzureTenantEndpoint:
      description: View for a serverless Azure tenant endpoint.
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the private
            endpoint.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        cloudProviderEndpointId:
          description: Unique string that identifies the Azure private endpoint's
            network interface that someone added to this private endpoint service.
          pattern: "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$"
          readOnly: true
          type: string
        comment:
          description: Human-readable comment associated with the private endpoint.
          maxLength: 80
          readOnly: true
          type: string
        endpointServiceName:
          description: Unique string that identifies the Azure private endpoint service.
            MongoDB Cloud returns null while it creates the endpoint service.
          pattern: "^pls_[0-9a-f]{24}$"
          readOnly: true
          type: string
        errorMessage:
          description: Human-readable error message that indicates error condition
            associated with establishing the private endpoint connection.
          readOnly: true
          type: string
        privateEndpointIpAddress:
          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}$"
          readOnly: true
          type: string
        privateLinkServiceResourceId:
          description: Root-relative path that identifies the Azure Private Link Service
            that MongoDB Cloud manages. MongoDB Cloud returns null while it creates
            the endpoint service.
          readOnly: true
          type: string
        providerName:
          description: Human-readable label that identifies the cloud service provider.
          enum:
          - AZURE
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the current operating status
            of the private endpoint.
          enum:
          - RESERVATION_REQUESTED
          - RESERVED
          - INITIATING
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
          type: string
      title: Azure
      type: object
    ServerlessAzureTenantEndpointUpdate:
      allOf:
      - "$ref": "#/components/schemas/ServerlessTenantEndpointUpdate"
      - properties:
          cloudProviderEndpointId:
            description: Unique string that identifies the Azure private endpoint's
              network interface for this private endpoint service.
            pattern: "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$"
            type: string
            writeOnly: true
          privateEndpointIpAddress:
            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}$"
            type: string
            writeOnly: true
        type: object
      description: Updates to a serverless Azure tenant endpoint.
      required:
      - providerName
      title: AZURE
      type: object
    ServerlessBackupRestoreJob:
      properties:
        cancelled:
          description: Flag that indicates whether someone canceled this restore job.
          readOnly: true
          type: boolean
        deliveryType:
          description: Human-readable label that categorizes the restore job to create.
          enum:
          - automated
          - download
          - pointInTime
          type: string
        deliveryUrl:
          description: 'One or more Uniform Resource Locators (URLs) that point to
            the compressed snapshot files for manual download. MongoDB Cloud returns
            this parameter when `"deliveryType" : "download"`.'
          items:
            description: One Uniform Resource Locator that points to the compressed
              snapshot files for manual download.
            type: string
          readOnly: true
          type: array
        desiredTimestamp:
          "$ref": "#/components/schemas/ApiBSONTimestampView"
        expired:
          description: Flag that indicates whether the restore job expired.
          readOnly: true
          type: boolean
        expiresAt:
          description: Date and time when the restore job expires. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        failed:
          description: Flag that indicates whether the restore job failed.
          readOnly: true
          type: boolean
        finishedAt:
          description: Date and time when the restore job completed. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal character string that identifies the
            restore job.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        oplogInc:
          description: 'Oplog operation number from which you want to restore this
            snapshot. This number represents the second part of an Oplog timestamp.
            The resource returns this parameter when `"deliveryType" : "pointInTime"`
            and `oplogTs` exceeds `0`.'
          example: 1
          format: int32
          minimum: 1
          type: integer
        oplogTs:
          description: 'Date and time from which you want to restore this snapshot.
            This parameter expresses this timestamp in the number of seconds that
            have elapsed since the UNIX epoch. This number represents the first part
            of an Oplog timestamp. The resource returns this parameter when `"deliveryType"
            : "pointInTime"` and `oplogTs` exceeds `0`.'
          format: int32
          minimum: 1199145600
          type: integer
        pointInTimeUTCSeconds:
          description: 'Date and time from which MongoDB Cloud restored this snapshot.
            This parameter expresses this timestamp in the number of seconds that
            have elapsed since the UNIX epoch. The resource returns this parameter
            when `"deliveryType" : "pointInTime"` and `pointInTimeUTCSeconds` exceeds
            `0`.'
          format: int32
          minimum: 1199145600
          type: integer
        snapshotId:
          description: Unique 24-hexadecimal character string that identifies the
            snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        targetClusterName:
          description: Human-readable label that identifies the target cluster to
            which the restore job restores the snapshot. The resource returns this
            parameter when `"deliveryType":` `"automated"`.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        targetGroupId:
          description: Unique 24-hexadecimal digit string that identifies the target
            project for the specified `targetClusterName`.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        timestamp:
          description: Date and time when MongoDB Cloud took the snapshot associated
            with `snapshotId`. This parameter expresses its value in the ISO 8601
            timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
      required:
      - deliveryType
      - targetClusterName
      - targetGroupId
      type: object
    ServerlessBackupSnapshot:
      properties:
        createdAt:
          description: Date and time when MongoDB Cloud took the snapshot. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        expiresAt:
          description: Date and time when MongoDB Cloud deletes the snapshot. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        frequencyType:
          description: Human-readable label that identifies how often this snapshot
            triggers.
          enum:
          - hourly
          - daily
          - weekly
          - monthly
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongodVersion:
          description: Version of the MongoDB host that this snapshot backs up.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        serverlessInstanceName:
          description: Human-readable label given to the serverless instance from
            which MongoDB Cloud took this snapshot.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        snapshotType:
          description: Human-readable label that identifies when this snapshot triggers.
          enum:
          - onDemand
          - scheduled
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the stage of the backup
            process for this snapshot.
          enum:
          - queued
          - inProgress
          - completed
          - failed
          readOnly: true
          type: string
        storageSizeBytes:
          description: Number of bytes taken to store the backup snapshot.
          format: int64
          readOnly: true
          type: integer
      type: object
    ServerlessConnectionPercentageRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessConnectionStringsPrivateEndpointItem:
      description: Details of a private endpoint deployed for this serverless instance.
      properties:
        endpointId:
          description: Unique string that the cloud provider uses to identify the
            private endpoint.
          readOnly: true
          type: string
        providerName:
          description: Cloud provider where the private endpoint is deployed.
          enum:
          - AWS
          - AZURE
          readOnly: true
          type: string
        region:
          description: Region where the private endpoint is deployed.
          readOnly: true
          type: string
      title: Serverless Instance Private Endpoint Connection Strings Endpoint
      type: object
    ServerlessConnectionStringsPrivateEndpointList:
      description: Private endpoint connection string that you can use to connect
        to this serverless instance through a private endpoint.
      externalDocs:
        description: Private Endpoint for Serverless Instance
        url: https://docs.atlas.mongodb.com/security-serverless-private-endpoint/
      properties:
        endpoints:
          description: List that contains the private endpoints through which you
            connect to MongoDB Cloud when you use `connectionStrings.privateEndpoint[n].srvConnectionString`.
          items:
            "$ref": "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem"
          readOnly: true
          type: array
        srvConnectionString:
          description: Private endpoint-aware connection string that uses the `mongodb+srv://`
            protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv`
            protocol tells the driver to look up the seed list of hosts in the Domain
            Name System (DNS).
          readOnly: true
          type: string
        type:
          description: MongoDB process type to which your application connects.
          enum:
          - MONGOS
          readOnly: true
          type: string
      title: Serverless Instance Private Endpoint Connection String
      type: object
    ServerlessEventTypeViewAlertable:
      description: Event type that triggers an alert.
      enum:
      - OUTSIDE_SERVERLESS_METRIC_THRESHOLD
      example: OUTSIDE_SERVERLESS_METRIC_THRESHOLD
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Serverless Event Types
      type: string
    ServerlessInstanceDescription:
      description: Group of settings that configure a MongoDB serverless instance.
      properties:
        connectionStrings:
          "$ref": "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings"
        createDate:
          description: Date and time when MongoDB Cloud created this serverless instance.
            MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the serverless
            instance.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mongoDBVersion:
          description: Version of MongoDB that the serverless instance runs.
          pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)"
          readOnly: true
          type: string
        name:
          description: Human-readable label that identifies the serverless instance.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        providerSettings:
          "$ref": "#/components/schemas/ServerlessProviderSettings"
        serverlessBackupOptions:
          "$ref": "#/components/schemas/ClusterServerlessBackupOptions"
        stateName:
          description: |-
            Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

             - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
             - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
             - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
             - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
             - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
          enum:
          - IDLE
          - CREATING
          - UPDATING
          - DELETING
          - REPAIRING
          readOnly: true
          type: string
        tags:
          description: List that contains key-value pairs between 1 to 255 characters
            in length for tagging and categorizing the serverless instance.
          items:
            "$ref": "#/components/schemas/ResourceTag"
          type: array
        terminationProtectionEnabled:
          default: false
          description: Flag that indicates whether termination protection is enabled
            on the serverless instance. If set to `true`, MongoDB Cloud won't delete
            the serverless instance. If set to `false`, MongoDB Cloud will delete
            the serverless instance.
          type: boolean
      required:
      - providerSettings
      title: Serverless Instance Description
      type: object
    ServerlessInstanceDescriptionConnectionStrings:
      description: Collection of Uniform Resource Locators that point to the MongoDB
        database.
      externalDocs:
        description: Connection string URI format.
        url: https://docs.mongodb.com/manual/reference/connection-string/
      properties:
        privateEndpoint:
          description: List of private endpoint-aware connection strings that you
            can use to connect to this serverless instance through a private endpoint.
            This parameter returns only if you created a private endpoint for this
            serverless instance and it is AVAILABLE.
          items:
            "$ref": "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList"
          readOnly: true
          type: array
        standardSrv:
          description: Public connection string that you can use to connect to this
            serverless instance. This connection string uses the `mongodb+srv://`
            protocol.
          externalDocs:
            description: Connection String URI Format
            url: https://docs.mongodb.com/manual/reference/connection-string/
          readOnly: true
          type: string
      readOnly: true
      title: Serverless Instance Connection Strings
      type: object
    ServerlessMetricAlertConfigViewForNdsGroup:
      description: Serverless metric alert configuration allows to select which serverless
        database metrics trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/ServerlessEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: Matching conditions for target resources.
          items:
            "$ref": "#/components/schemas/AlertMatcher"
          type: array
        metricThreshold:
          "$ref": "#/components/schemas/ServerlessMetricThreshold"
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Serverless Alert Configuration
      type: object
    ServerlessMetricThreshold:
      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 about the serverless database.
      discriminator:
        mapping:
          SERVERLESS_AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/ServerlessAVGCommandExecutionTimeMetricThresholdView"
          SERVERLESS_AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView"
          SERVERLESS_AVG_WRITE_EXECUTION_TIME: "#/components/schemas/ServerlessAVGWriteExecutionTimeMetricThresholdView"
          SERVERLESS_CONNECTIONS: "#/components/schemas/RawMetricThresholdView"
          SERVERLESS_CONNECTIONS_PERCENT: "#/components/schemas/ServerlessConnectionPercentageRawMetricThresholdView"
          SERVERLESS_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricThresholdView"
          SERVERLESS_NETWORK_BYTES_IN: "#/components/schemas/ServerlessNetworkBytesInDataMetricThresholdView"
          SERVERLESS_NETWORK_BYTES_OUT: "#/components/schemas/ServerlessNetworkBytesOutDataMetricThresholdView"
          SERVERLESS_NETWORK_NUM_REQUESTS: "#/components/schemas/ServerlessNetworkNumRequestRawMetricThresholdView"
          SERVERLESS_OPCOUNTER_CMD: "#/components/schemas/ServerlessOpCounterCDMRawMetricThresholdView"
          SERVERLESS_OPCOUNTER_DELETE: "#/components/schemas/ServerlessOpCounterDeleteRawMetricThresholdView"
          SERVERLESS_OPCOUNTER_GETMORE: "#/components/schemas/ServerlessOpCounterGetMoreRawMetricThresholdView"
          SERVERLESS_OPCOUNTER_INSERT: "#/components/schemas/ServerlessOpCounterInsertRawMetricThresholdView"
          SERVERLESS_OPCOUNTER_QUERY: "#/components/schemas/ServerlessOpCounterQueryRawMetricThresholdView"
          SERVERLESS_OPCOUNTER_UPDATE: "#/components/schemas/ServerlessOpCounterUpdateRawMetricThresholdView"
          SERVERLESS_TOTAL_READ_UNITS: "#/components/schemas/RPUMetricThresholdView"
          SERVERLESS_TOTAL_WRITE_UNITS: "#/components/schemas/ServerlessTotalWriteUnitsRPUMetricThresholdView"
        propertyName: metricName
      oneOf:
      - "$ref": "#/components/schemas/ServerlessAVGCommandExecutionTimeMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessAVGWriteExecutionTimeMetricThresholdView"
      - "$ref": "#/components/schemas/TimeMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessTotalWriteUnitsRPUMetricThresholdView"
      - "$ref": "#/components/schemas/RPUMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessOpCounterUpdateRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessOpCounterQueryRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessOpCounterInsertRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessOpCounterGetMoreRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessOpCounterDeleteRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessOpCounterCDMRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessNetworkNumRequestRawMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessNetworkBytesOutDataMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessNetworkBytesInDataMetricThresholdView"
      - "$ref": "#/components/schemas/DataMetricThresholdView"
      - "$ref": "#/components/schemas/ServerlessConnectionPercentageRawMetricThresholdView"
      - "$ref": "#/components/schemas/RawMetricThresholdView"
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      required:
      - metricName
      title: Serverless Metric Threshold
      type: object
    ServerlessMetricUnits:
      description: Element used to express the quantity. This can be an element of
        time, storage capacity, and the like.
      enum:
      - RPU
      - THOUSAND_RPU
      - MILLION_RPU
      - WPU
      - THOUSAND_WPU
      - MILLION_WPU
      example: RPU
      title: Serverless Metric Units
      type: string
    ServerlessNetworkBytesInDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    ServerlessNetworkBytesOutDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    ServerlessNetworkNumRequestRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessOpCounterCDMRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessOpCounterDeleteRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessOpCounterGetMoreRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessOpCounterInsertRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessOpCounterQueryRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessOpCounterUpdateRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    ServerlessProviderSettings:
      description: Group of cloud provider settings that configure the provisioned
        MongoDB serverless instance.
      properties:
        backingProviderName:
          description: Cloud service provider on which MongoDB Cloud provisioned the
            serverless instance.
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
        effectiveDiskSizeGBLimit:
          description: Storage capacity of instance data volumes expressed in gigabytes.
            This value is not configurable for Serverless or effectively Flex clusters.
          format: int32
          readOnly: true
          type: integer
        effectiveInstanceSizeName:
          "$ref": "#/components/schemas/BaseCloudProviderInstanceSize"
        effectiveProviderName:
          description: Cloud service provider on which MongoDB Cloud effectively provisioned
            the serverless instance.
          readOnly: true
          type: string
        providerName:
          default: SERVERLESS
          description: Human-readable label that identifies the cloud service provider.
          enum:
          - SERVERLESS
          type: string
        regionName:
          description: Human-readable label that identifies the geographic location
            of your MongoDB serverless instance. The region you choose can affect
            network latency for clients accessing your databases. For a complete list
            of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
            [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
          type: string
      required:
      - backingProviderName
      - regionName
      title: Cloud Service Provider Settings for a Serverless Instance
      type: object
    ServerlessTenantCreateRequest:
      properties:
        comment:
          description: Human-readable comment associated with the private endpoint.
          maxLength: 80
          type: string
          writeOnly: true
      type: object
    ServerlessTenantEndpoint:
      oneOf:
      - "$ref": "#/components/schemas/ServerlessAWSTenantEndpoint"
      - "$ref": "#/components/schemas/ServerlessAzureTenantEndpoint"
      properties:
        _id:
          description: Unique 24-hexadecimal digit string that identifies the private
            endpoint.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        cloudProviderEndpointId:
          description: Unique string that identifies the private endpoint's network
            interface.
          readOnly: true
          type: string
        comment:
          description: Human-readable comment associated with the private endpoint.
          maxLength: 80
          readOnly: true
          type: string
        endpointServiceName:
          description: Unique string that identifies the 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}|pls_[0-9a-f]{24}$"
          readOnly: true
          type: string
        errorMessage:
          description: Human-readable error message that indicates error condition
            associated with establishing the private endpoint connection.
          readOnly: true
          type: string
        status:
          description: Human-readable label that indicates the current operating status
            of the private endpoint.
          enum:
          - RESERVATION_REQUESTED
          - RESERVED
          - INITIATING
          - AVAILABLE
          - FAILED
          - DELETING
          readOnly: true
          type: string
      type: object
    ServerlessTenantEndpointUpdate:
      description: Update view for a serverless tenant endpoint.
      discriminator:
        mapping:
          AWS: "#/components/schemas/ServerlessAWSTenantEndpointUpdate"
          AZURE: "#/components/schemas/ServerlessAzureTenantEndpointUpdate"
        propertyName: providerName
      properties:
        comment:
          description: Human-readable comment associated with the private endpoint.
          maxLength: 80
          type: string
          writeOnly: true
        providerName:
          description: Human-readable label that identifies the cloud provider of
            the tenant endpoint.
          enum:
          - AWS
          - AZURE
          type: string
          writeOnly: true
      required:
      - providerName
      type: object
    ServerlessTotalWriteUnitsRPUMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/ServerlessMetricUnits"
      required:
      - metricName
      type: object
    ServiceAccountEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - SERVICE_ACCOUNT_CREATED
      - SERVICE_ACCOUNT_DELETED
      - SERVICE_ACCOUNT_ROLES_CHANGED
      - SERVICE_ACCOUNT_DETAILS_CHANGED
      - SERVICE_ACCOUNT_ADDED_TO_GROUP
      - SERVICE_ACCOUNT_REMOVED_FROM_GROUP
      - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED
      - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED
      - SERVICE_ACCOUNT_SECRET_ADDED
      - SERVICE_ACCOUNT_SECRET_DELETED
      - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED
      - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED
      title: Service Account Event Types
      type: string
    ServiceAccountEventTypeViewForOrg:
      description: Unique identifier of event type.
      enum:
      - SERVICE_ACCOUNT_CREATED
      - SERVICE_ACCOUNT_DELETED
      - SERVICE_ACCOUNT_ROLES_CHANGED
      - SERVICE_ACCOUNT_DETAILS_CHANGED
      - SERVICE_ACCOUNT_ADDED_TO_GROUP
      - SERVICE_ACCOUNT_REMOVED_FROM_GROUP
      - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED
      - SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED
      - SERVICE_ACCOUNT_SECRET_ADDED
      - SERVICE_ACCOUNT_SECRET_DELETED
      - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED
      - SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED
      title: Service Account Event Types
      type: string
    ServiceAccountGroup:
      properties:
        groupId:
          description: 'Unique 24-hexadecimal digit string that identifies your project.
            **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.'
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      type: object
    ServiceAccountGroupEvents:
      description: Service Account event identifies different activities around user
        API keys.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: ServiceAccount Events
      type: object
    ServiceAccountIPAccessListEntry:
      properties:
        cidrBlock:
          description: Range of network addresses in the access list for the Service
            Account. This parameter requires the range to be expressed in Classless
            Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or
            version 6 addresses. You can set a value for this parameter or `ipAddress`,
            but not for both in the same request.
          example: 203.0.113.0/24
          pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
          type: string
        createdAt:
          description: Date MongoDB Cloud added the entry was added to the Access
            List. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC.
          format: date-time
          readOnly: true
          type: string
        ipAddress:
          description: Network address in the access list for the Service Account.
            This parameter requires the address to be expressed as one Internet Protocol
            version 4 or version 6 address. You can set a value for this parameter
            or `cidrBlock`, but not for both in the same request.
          example: 203.0.113.10
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
        lastUsedAddress:
          description: Network address that issued the most recent request to the
            API. This parameter requires the address to be expressed as one Internet
            Protocol version 4 or version 6 address. The resource returns this parameter
            after this IP address makes at least one request.
          example: 203.0.113.10
          readOnly: true
          type: string
        lastUsedAt:
          description: Date when MongoDB Cloud received the most recent request that
            originated from this Internet Protocol version 4 or version 6 address.
            The resource returns this parameter when at least one request originates
            from this IP address. MongoDB Cloud updates this parameter each time a
            client accesses the permitted resource, with a delay of up to 5 minutes.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        requestCount:
          description: The number of requests that has originated from this network
            address.
          format: int32
          readOnly: true
          type: integer
      type: object
    ServiceAccountOrgEvents:
      description: Service Account event identifies different activities around user
        API keys.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/ServiceAccountEventTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: ServiceAccount Events
      type: object
    ServiceAccountSecret:
      properties:
        createdAt:
          description: The date that the secret was created on. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        expiresAt:
          description: The date for the expiration of the secret. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the secret.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastUsedAt:
          description: The last time the secret was used. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        maskedSecretValue:
          description: The masked Service Account secret.
          example: mdb_sa_sk_...
          readOnly: true
          type: string
        secret:
          description: The secret for the Service Account. It will be returned only
            the first time after creation.
          example: mdb_sa_sk_...
          readOnly: true
          type: string
      required:
      - createdAt
      - expiresAt
      - id
      type: object
    ServiceAccountSecretRequest:
      properties:
        secretExpiresAfterHours:
          description: The expiration time of the new Service Account secret, provided
            in hours. The minimum and maximum allowed expiration times are subject
            to change and are controlled by the organization's settings.
          example: 8
          format: int32
          type: integer
      required:
      - secretExpiresAfterHours
      type: object
    ShardEntry:
      description: Sharding configuration for a collection to be sharded on the destination
        cluster.
      properties:
        collection:
          description: Human-readable label that identifies the collection to be sharded
            on the destination cluster.
          type: string
          writeOnly: true
        database:
          description: Human-readable label that identifies the database that contains
            the collection to be sharded on the destination cluster.
          type: string
          writeOnly: true
        shardCollection:
          "$ref": "#/components/schemas/ShardKeys"
      required:
      - collection
      - database
      - shardCollection
      type: object
    ShardKeys:
      description: Document that configures the shard key on the destination cluster.
      properties:
        key:
          description: List of fields to use for the shard key.
          items:
            additionalProperties:
              type: object
            type: object
          type: array
          uniqueItems: true
          writeOnly: true
      required:
      - key
      type: object
      writeOnly: true
    ShardingRequest:
      description: Document that configures sharding on the destination cluster when
        migrating from a replica set source to a sharded cluster destination on MongoDB
        6.0 or higher. If you don't wish to shard any collections on the destination
        cluster, leave this empty.
      properties:
        createSupportingIndexes:
          description: Flag that lets the migration create supporting indexes for
            the shard keys, if none exists, as the destination cluster also needs
            compatible indexes for the specified shard keys.
          type: boolean
          writeOnly: true
        shardingEntries:
          description: List of shard configurations to shard destination collections.
            Atlas shards only those collections that you include in the sharding entries
            array.
          items:
            "$ref": "#/components/schemas/ShardEntry"
          type: array
          uniqueItems: true
          writeOnly: true
      required:
      - createSupportingIndexes
      - shardingEntries
      type: object
      writeOnly: true
    SkuResponse:
      properties:
        description:
          description: Human-readable short summary of what this SKU represents.
          readOnly: true
          type: string
        id:
          description: Unique string that identifies the SKU.
          readOnly: true
          type: string
      type: object
    Slack:
      description: Details to integrate one Slack account with one MongoDB Cloud project.
      properties:
        apiToken:
          description: |-
            Key that allows MongoDB Cloud to access your Slack account.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.

            **IMPORTANT**: Slack integrations now use the OAuth2 verification method and must  be initially configured, or updated from a legacy integration, through the Atlas  third-party service integrations page. Legacy tokens will soon no longer be  supported.
          example: "**********************************************************************abcd"
          type: string
        channelName:
          description: Name of the Slack channel to which MongoDB Cloud sends alert
            notifications.
          example: alerts
          maxLength: 80
          minLength: 1
          nullable: true
          type: string
        id:
          description: Integration id.
          nullable: true
          type: string
        teamName:
          description: Human-readable label that identifies your Slack team. Set this
            parameter when you configure a legacy Slack integration.
          example: MongoDB
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - SLACK
          type: string
      required:
      - apiToken
      - channelName
      title: SLACK
      type: object
    SlackNotification:
      description: Slack notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        apiToken:
          description: "Slack API token or Bot token that MongoDB Cloud needs to send
            alert notifications via Slack. The resource requires this parameter when
            `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes
            invalid, MongoDB Cloud sends an email to the project owners. If the token
            remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After
            you create a notification which requires an API or integration key, the
            key appears partially redacted when you:\n\n* View or edit the alert through
            the Atlas UI.\n\n* Query the alert for the notification through the Atlas
            Administration API."
          example: "**********************************************************************abcd"
          type: string
        channelName:
          description: 'Name of the Slack channel to which MongoDB Cloud sends alert
            notifications. The resource requires this parameter when `"notifications.[n].typeName"
            : "SLACK"`.'
          example: alerts
          type: string
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - SLACK
          type: string
      required:
      - typeName
      title: Slack Notification
      type: object
    Source:
      description: Document that describes the source of the migration.
      properties:
        caCertificatePath:
          description: Path to the CA certificate that signed SSL certificates use
            to authenticate to the source cluster.
          type: string
        clusterName:
          description: Label that identifies the source cluster name.
          minLength: 1
          type: string
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the source
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        managedAuthentication:
          description: Flag that indicates whether MongoDB Automation manages authentication
            to the source cluster. If true, do not provide values for username and
            password.
          type: boolean
        password:
          description: Password that authenticates the username to the source cluster.
          type: string
          writeOnly: true
        ssl:
          description: Flag that indicates whether you have SSL enabled.
          type: boolean
        username:
          description: Label that identifies the SCRAM-SHA user that connects to the
            source cluster.
          type: string
          writeOnly: true
      required:
      - clusterName
      - groupId
      - managedAuthentication
      - ssl
      type: object
    SplunkLogIntegrationRequest:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationRequest"
      - properties:
          hecToken:
            description: HTTP Event Collector (HEC) token for authentication.
            example: 12345678-1234-1234-1234-123456789012
            format: password
            type: string
          hecUrl:
            description: HTTP Event Collector (HEC) endpoint URL.
            example: https://http-inputs-acme.splunkcloud.com:8088/services/collector/event
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - SPLUNK_LOG_EXPORT
            type: string
        type: object
      description: Request schema for creating or updating a Splunk log export integration.
      required:
      - hecToken
      - hecUrl
      - logTypes
      - type
      title: Splunk Log Export Integration Request
      type: object
    SplunkLogIntegrationResponse:
      allOf:
      - "$ref": "#/components/schemas/LogIntegrationResponse"
      - properties:
          hecToken:
            description: HTTP Event Collector (HEC) token for authentication.
            example: "****************************9012"
            format: password
            type: string
          hecUrl:
            description: HTTP Event Collector (HEC) endpoint URL.
            example: https://http-inputs-acme.splunkcloud.com:8088/services/collector
            type: string
          type:
            description: Human-readable label that identifies the service to which
              you want to integrate with Atlas. The value must match the log integration
              type. This value cannot be modified after the integration is created.
            enum:
            - SPLUNK_LOG_EXPORT
            type: string
        type: object
      description: Details to integrate Splunk log export with one Atlas project.
      required:
      - hecToken
      - hecUrl
      - id
      - logTypes
      - type
      title: Splunk Log Export Integration Response
      type: object
    StateReason:
      description: State reason of the Job. This is set when the job state is "Failed".
      properties:
        errorCode:
          description: Error code relating to state.
          type: string
        message:
          description: Message describing error or state.
          type: string
      readOnly: true
      type: object
    StreamConfig:
      description: Configuration options for an Atlas Stream Processing Workspace.
      nullable: true
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        maxTierSize:
          description: Max tier size for the Stream Workspace. Configures Memory /
            VCPU allowances.
          enum:
          - SP50
          - SP30
          - SP10
          - SP5
          - SP2
          title: Stream Workspace Max Tier Size
          type: string
        tier:
          description: Selected tier for the Stream Workspace. Configures Memory /
            VCPU allowances.
          enum:
          - SP50
          - SP30
          - SP10
          - SP5
          - SP2
          title: Stream Workspace Tier
          type: string
      type: object
    StreamProcessorAlertConfigViewForNdsGroup:
      description: Host metric alert configuration allows to select which Atlas streams
        processors trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/StreamProcessorEventTypeViewAlertableNoThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: List of rules that determine whether MongoDB Cloud checks an
            object for the alert configuration.
          items:
            "$ref": "#/components/schemas/StreamsMatcher"
          type: array
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Stream Processor Alert Configuration
      type: object
    StreamProcessorAlertViewForNdsGroup:
      description: Stream Processor alert notifies about activities on Stream Processor
        in Atlas Streams.
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        instanceName:
          description: The name of the Stream Processing Workspace to which this alert
            applies. The resource returns this parameter for alerts of events impacting
            Stream Processing Workspaces.
          example: foobar
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        processorErrorMsg:
          description: The error message associated with the Stream Processor to which
            this alert applies.
          example: 'MongoServerError: Failed to start stream processor: (Location77175)
            Could not connect to the Kafka topic with kafka error code: -195, message:
            Local: Broker transport failure.: (Location77175)'
          readOnly: true
          type: string
        processorName:
          description: The name of the Stream Processor to which this alert applies.
            The resource returns this parameter for alerts of events impacting Stream
            Processors.
          example: foobar
          readOnly: true
          type: string
        processorState:
          description: The state of the Stream Processor to which this alert applies.
            The resource returns this parameter for alerts of events impacting Stream
            Processors.
          example: STARTED
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      title: Stream Processor Alerts
      type: object
    StreamProcessorEventTypeViewAlertableNoThreshold:
      description: Event type that triggers an alert.
      enum:
      - STREAM_PROCESSOR_STATE_IS_FAILED
      example: STREAM_PROCESSOR_STATE_IS_FAILED
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Stream Processor Event Types
      type: string
    StreamProcessorEventTypeViewAlertableWithThreshold:
      description: Event type that triggers an alert.
      enum:
      - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
      example: OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
      externalDocs:
        description: Atlas Alert Event Types
        url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
      title: Stream Processor Event Types
      type: string
    StreamProcessorEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - STREAM_PROCESSOR_STATE_IS_FAILED
      - INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
      - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD
      example: STREAM_PROCESSOR_STATE_IS_FAILED
      title: Stream Processor Event Types
      type: string
    StreamProcessorEventViewForNdsGroup:
      description: Stream Processor event identifies different activities about a
        stream processor in Atlas Streams.
      properties:
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        instanceName:
          description: Name of the stream processing workspace associated with the
            event.
          example: foobar
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        processorErrorMsg:
          description: Error message linked to the stream processor associated with
            the event.
          example: invalid auth
          readOnly: true
          type: string
        processorName:
          description: Name of the stream processor associated with the event.
          example: foobar
          readOnly: true
          type: string
        processorState:
          description: State of the stream processor associated with the event.
          example: FAILED
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
      required:
      - created
      - eventTypeName
      - id
      title: Stream Processor Events
      type: object
    StreamProcessorMetricAlertConfigViewForNdsGroup:
      description: Stream Processor threshold alert configuration allows to select
        thresholds on metrics which trigger alerts and how users are notified.
      properties:
        created:
          description: Date and time when MongoDB Cloud created the alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        enabled:
          default: false
          description: Flag that indicates whether someone enabled this alert configuration
            for the specified project.
          type: boolean
        eventTypeName:
          "$ref": "#/components/schemas/StreamProcessorEventTypeViewAlertableWithThreshold"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert
            configuration.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        matchers:
          description: List of rules that determine whether MongoDB Cloud checks an
            object for the alert configuration.
          items:
            "$ref": "#/components/schemas/StreamsMatcher"
          type: array
        metricThreshold:
          "$ref": "#/components/schemas/StreamProcessorMetricThreshold"
        notifications:
          description: List that contains the targets that MongoDB Cloud sends notifications.
          items:
            "$ref": "#/components/schemas/AlertsNotificationRootForGroup"
          maxItems: 25
          minItems: 1
          type: array
        severityOverride:
          "$ref": "#/components/schemas/EventSeverity"
        threshold:
          "$ref": "#/components/schemas/DeprecatedStreamProcessorMetricThreshold"
        updated:
          description: Date and time when someone last updated this alert configuration.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - eventTypeName
      - notifications
      title: Stream Processor Metric Alert Configuration
      type: object
    StreamProcessorMetricThreshold:
      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 stream processors.
      discriminator:
        mapping:
          STREAM_PROCESSOR_CHANGE_STREAM_LAG: "#/components/schemas/TimeMetricThresholdView"
          STREAM_PROCESSOR_DLQ_MESSAGE_COUNT: "#/components/schemas/DLQRawMetricThresholdView"
          STREAM_PROCESSOR_KAFKA_LAG: "#/components/schemas/KafkaRawMetricThresholdView"
          STREAM_PROCESSOR_OUTPUT_MESSAGE_COUNT: "#/components/schemas/RawMetricThresholdView"
        propertyName: metricName
      oneOf:
      - "$ref": "#/components/schemas/KafkaRawMetricThresholdView"
      - "$ref": "#/components/schemas/TimeMetricThresholdView"
      - "$ref": "#/components/schemas/DLQRawMetricThresholdView"
      - "$ref": "#/components/schemas/RawMetricThresholdView"
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          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
          - tokens
          - million tokens
          - pixels
          - billion pixels
          - GB seconds
          - GB hours
          - GB days
          - RPU
          - thousand RPU
          - million RPU
          - WPU
          - thousand WPU
          - million WPU
          - count
          - thousand
          - million
          - billion
          type: string
      required:
      - metricName
      title: Stream Processor Metric Threshold
      type: object
    StreamsAWSConnectionConfig:
      description: AWS configurations for AWS-based connection types.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        roleArn:
          description: Amazon Resource Name (ARN) that identifies the Amazon Web Services
            (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes
            when it accesses resources in your AWS account.
          type: string
        testBucket:
          description: The name of an S3 bucket used to check authorization of the
            passed-in IAM role ARN.
          type: string
      type: object
    StreamsAWSKinesisDataStreamsConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          aws:
            "$ref": "#/components/schemas/StreamsAWSConnectionConfig"
          networking:
            "$ref": "#/components/schemas/StreamsKafkaNetworking"
        type: object
      description: The configuration for AWS Kinesis Data Stream connections.
      type: object
    StreamsAWSLambdaConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          aws:
            "$ref": "#/components/schemas/StreamsAWSConnectionConfig"
        type: object
      description: The configuration for AWS Lambda connections.
      type: object
    StreamsAzureBlobStorageConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          azure:
            "$ref": "#/components/schemas/AzureConnection"
          publicPrivateNetworking:
            "$ref": "#/components/schemas/StreamsPublicPrivateLinkNetworking"
        type: object
      description: The configuration for Azure Blob Storage connections.
      type: object
    StreamsClusterConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          clusterGroupId:
            description: Unique 24-hexadecimal digit string that identifies the project
              that contains the configured cluster. Required if the ID does not match
              the project containing the streams workspace. You must first enable
              the organization setting.
            type: string
          clusterName:
            description: Name of the cluster configured for this connection.
            type: string
          dbRoleToExecute:
            "$ref": "#/components/schemas/DBRoleToExecute"
        type: object
      type: object
    StreamsConnection:
      description: Settings that define a connection to an external data store.
      discriminator:
        mapping:
          AWSKinesisDataStreams: "#/components/schemas/StreamsAWSKinesisDataStreamsConnection"
          AWSLambda: "#/components/schemas/StreamsAWSLambdaConnection"
          AzureBlobStorage: "#/components/schemas/StreamsAzureBlobStorageConnection"
          Cluster: "#/components/schemas/StreamsClusterConnection"
          GCPPubSub: "#/components/schemas/StreamsGCPPubSubConnection"
          Https: "#/components/schemas/StreamsHttpsConnection"
          Kafka: "#/components/schemas/StreamsKafkaConnection"
          S3: "#/components/schemas/StreamsS3Connection"
          Sample: "#/components/schemas/StreamsSampleConnection"
          SchemaRegistry: "#/components/schemas/StreamsSchemaRegistryConnection"
        propertyName: type
      oneOf:
      - "$ref": "#/components/schemas/StreamsSampleConnection"
      - "$ref": "#/components/schemas/StreamsClusterConnection"
      - "$ref": "#/components/schemas/StreamsKafkaConnection"
      - "$ref": "#/components/schemas/StreamsHttpsConnection"
      - "$ref": "#/components/schemas/StreamsAWSLambdaConnection"
      - "$ref": "#/components/schemas/StreamsS3Connection"
      - "$ref": "#/components/schemas/StreamsAWSKinesisDataStreamsConnection"
      - "$ref": "#/components/schemas/StreamsSchemaRegistryConnection"
      - "$ref": "#/components/schemas/StreamsAzureBlobStorageConnection"
      - "$ref": "#/components/schemas/StreamsGCPPubSubConnection"
      properties:
        id:
          description: Unique identifier of the connection.
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the stream connection.
            In the case of the Sample type, this is the name of the sample source.
          type: string
        region:
          description: The connection's region.
          type: string
        state:
          description: The state of the connection.
          enum:
          - PENDING
          - READY
          - DELETING
          - FAILED
          readOnly: true
          type: string
        type:
          description: Type of the connection.
          enum:
          - Kafka
          - Cluster
          - Sample
          - Https
          - AzureBlobStorage
          - AWSLambda
          - AWSKinesisDataStreams
          - SchemaRegistry
          - GCPPubSub
          type: string
      type: object
    StreamsDLQ:
      description: Dead letter queue for the stream processor.
      externalDocs:
        url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue
      properties:
        coll:
          description: Name of the collection to use for the DLQ.
          type: string
        connectionName:
          description: Name of the connection to write DLQ messages to. Must be an
            Atlas connection.
          type: string
        db:
          description: Name of the database to use for the DLQ.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    StreamsDataProcessRegion:
      description: Information about the cloud provider region in which MongoDB Cloud
        processes the stream.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - GCP
          - AZURE
          - TENANT
          - SERVERLESS
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        region:
          "$ref": "#/components/schemas/BaseStreamsRegion"
      required:
      - cloudProvider
      - region
      type: object
    StreamsEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - MAX_PROCESSOR_COUNT_REACHED
      example: MAX_PROCESSOR_COUNT_REACHED
      title: Streams Event Types
      type: string
    StreamsEventViewForNdsGroup:
      description: Streams event identifies different activities about Atlas Streams.
      properties:
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/StreamsEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        instanceName:
          description: Name of the stream processing workspace associated with the
            event.
          example: foobar
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
      required:
      - created
      - eventTypeName
      - id
      title: Streams Events
      type: object
    StreamsGCPConnectionConfig:
      description: GCP-specific configuration for the connection.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        serviceAccountId:
          description: Email address of the Google Cloud Platform (GCP) service account
            that Atlas Streams uses to connect to the GCP Pub/Sub resources.
          type: string
      type: object
    StreamsGCPPubSubConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          gcp:
            "$ref": "#/components/schemas/StreamsGCPConnectionConfig"
          publicPrivateNetworking:
            "$ref": "#/components/schemas/StreamsPublicPrivateLinkNetworking"
        type: object
      description: The configuration for GCP Pub/Sub connections.
      type: object
    StreamsHttpsConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          headers:
            additionalProperties:
              description: A map of key-value pairs that will be passed as headers
                for the request.
              type: string
            description: A map of key-value pairs that will be passed as headers for
              the request.
            type: object
          url:
            description: The URL to be used for the request.
            type: string
        type: object
      type: object
    StreamsKafkaAuthentication:
      description: User credentials required to connect to a Kafka Cluster. Includes
        the authentication type, as well as the parameters for that authentication
        mode.
      properties:
        clientId:
          description: OIDC client identifier for authentication to the Kafka cluster.
          type: string
        clientSecret:
          description: OIDC client secret for authentication to the Kafka cluster.
          format: password
          type: string
          writeOnly: true
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        mechanism:
          description: Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512,
            or OAUTHBEARER.
          type: string
        method:
          description: SASL OAUTHBEARER authentication method. Can only be OIDC currently.
          type: string
        password:
          description: Password of the account to connect to the Kafka cluster.
          format: password
          type: string
          writeOnly: true
        saslOauthbearerExtensions:
          description: SASL OAUTHBEARER extensions parameter for additional OAuth2
            configuration.
          type: string
        scope:
          description: OIDC scope parameter defining the access permissions requested.
          type: string
        sslCertificate:
          description: SSL certificate for client authentication to Kafka.
          type: string
        sslKey:
          description: SSL key for client authentication to Kafka.
          type: string
          writeOnly: true
        sslKeyPassword:
          description: Password for the SSL key, if it is password protected.
          type: string
          writeOnly: true
        tokenEndpointUrl:
          description: OIDC token endpoint URL for obtaining access tokens.
          type: string
        username:
          description: Username of the account to connect to the Kafka cluster.
          type: string
      type: object
    StreamsKafkaConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          authentication:
            "$ref": "#/components/schemas/StreamsKafkaAuthentication"
          bootstrapServers:
            description: Comma separated list of server addresses.
            type: string
          config:
            additionalProperties:
              description: A map of Kafka key-value pairs for optional configuration.
                This is a flat object, and keys can have '.' characters.
              example: '{"group.protocol.type":"consumer","debug":"queue, msg, protocol"}'
              type: string
            description: A map of Kafka key-value pairs for optional configuration.
              This is a flat object, and keys can have '.' characters.
            example:
              debug: queue, msg, protocol
              group.protocol.type: consumer
            type: object
          networking:
            "$ref": "#/components/schemas/StreamsKafkaNetworking"
          security:
            "$ref": "#/components/schemas/StreamsKafkaSecurity"
        type: object
      type: object
    StreamsKafkaNetworking:
      description: Networking configuration for Streams connections.
      properties:
        access:
          "$ref": "#/components/schemas/StreamsKafkaNetworkingAccess"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    StreamsKafkaNetworkingAccess:
      description: Information about networking access.
      properties:
        connectionId:
          description: Reserved. Will be used by `PRIVATE_LINK` connection type.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Reserved. Will be used by `PRIVATE_LINK` connection type.
          type: string
        tgwRouteId:
          description: Reserved. Will be used by `TRANSIT_GATEWAY` connection type.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        type:
          description: Selected networking type. Either `PUBLIC`, `VPC`, `PRIVATE_LINK`,
            or `TRANSIT_GATEWAY`. Defaults to `PUBLIC`. For VPC, ensure that VPC peering
            exists and connectivity has been established between Atlas VPC and the
            VPC where Kafka cluster is hosted for the connection to function properly.
            `TRANSIT_GATEWAY` support is coming soon.
          enum:
          - PUBLIC
          - VPC
          - PRIVATE_LINK
          - TRANSIT_GATEWAY
          title: Networking Access Type
          type: string
      type: object
    StreamsKafkaSecurity:
      description: Properties for the secure transport connection to Kafka. For SSL,
        this can include the trusted certificate to use.
      properties:
        brokerPublicCertificate:
          description: A trusted, public x509 certificate for connecting to Kafka
            over SSL.
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        protocol:
          description: Describes the transport type. Can be either `SASL_PLAINTEXT`,
            `SASL_SSL`, or `SSL`.
          type: string
      type: object
    StreamsMatcher:
      description: Rules to apply when comparing a stream processing workspace or
        stream processor against this alert configuration.
      properties:
        fieldName:
          "$ref": "#/components/schemas/StreamsMatcherField"
        operator:
          description: Comparison operator to apply when checking the current metric
            value against **matcher[n].value**. The `REGEX` operator only supports
            inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.
          enum:
          - EQUALS
          - CONTAINS
          - STARTS_WITH
          - ENDS_WITH
          - NOT_EQUALS
          - NOT_CONTAINS
          - REGEX
          type: string
        value:
          description: Value to match or exceed using the specified `matchers.operator`.
          example: event-replica-set
          type: string
      required:
      - fieldName
      - operator
      - value
      title: Matchers
      type: object
    StreamsMatcherField:
      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:
      - INSTANCE_NAME
      - PROCESSOR_NAME
      example: INSTANCE_NAME
      title: Streams Matcher Fields
      type: string
    StreamsModifyStreamProcessor:
      description: A request to modify an existing stream processor.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: New name for the stream processor.
          type: string
        options:
          "$ref": "#/components/schemas/StreamsModifyStreamProcessorOptions"
        pipeline:
          description: New pipeline for the stream processor.
          externalDocs:
            description: Supported Aggregation Pipeline Stages
            url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation
          items:
            "$ref": "#/components/schemas/Document"
          type: array
      type: object
    StreamsModifyStreamProcessorOptions:
      description: Additional options for modifying a stream processor.
      properties:
        dlq:
          "$ref": "#/components/schemas/StreamsDLQ"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        resumeFromCheckpoint:
          description: When true, the modified stream processor resumes from its last
            checkpoint.
          type: boolean
      type: object
    StreamsOptions:
      description: Optional configuration for the stream processor.
      properties:
        dlq:
          "$ref": "#/components/schemas/StreamsDLQ"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    StreamsPrivateLinkConnection:
      description: Container for metadata needed to create a Private Link connection.
      properties:
        _id:
          description: The ID of the Private Link connection.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        arn:
          description: Amazon Resource Name (ARN). Required for AWS Provider and MSK
            vendor.
          pattern: "^arn:aws:kafka"
          type: string
        azureResourceIds:
          description: Azure Resource IDs of each availability zone for the Azure
            Confluent cluster.
          items:
            type: string
          type: array
        dnsDomain:
          description: |-
            The domain hostname. Required for the following provider and vendor combinations:
            - AWS provider with CONFLUENT vendor.
            - AZURE provider with EVENTHUB or CONFLUENT vendor.
          type: string
        dnsSubDomain:
          description: Sub-Domain name of Confluent cluster. These are typically your
            availability zones. Required for AWS Provider and CONFLUENT vendor, if
            your AWS CONFLUENT cluster doesn't use subdomains, you must set this to
            the empty array [].
          items:
            type: string
          type: array
        errorMessage:
          description: Error message if the state is FAILED.
          readOnly: true
          type: string
        gcpConnectionIds:
          description: List of GCP Private Service Connect connection IDs.
          items:
            type: string
          maxItems: 3
          type: array
          uniqueItems: true
        gcpServiceAttachmentUris:
          description: Service Attachment URIs of each availability zone for the GCP
            Confluent cluster.
          items:
            type: string
          maxItems: 3
          type: array
          uniqueItems: true
        interfaceEndpointId:
          description: Interface endpoint ID that is created from the service endpoint
            ID provided.
          readOnly: true
          type: string
        interfaceEndpointName:
          description: Interface endpoint name that is created from the service endpoint
            ID provided.
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        provider:
          description: Provider where the Kafka cluster is deployed. Valid values
            are AWS and AZURE.
          type: string
        providerAccountId:
          description: Account ID from the cloud provider.
          readOnly: true
          type: string
        region:
          description: The region of the Provider’s cluster. See [AZURE](https://www.mongodb.com/docs/atlas/reference/microsoft-azure/#stream-processing-instances)
            and [AWS](https://www.mongodb.com/docs/atlas/reference/amazon-aws/#stream-processing-instances)
            supported regions.
          type: string
        serviceEndpointId:
          description: For AZURE EVENTHUB, this is the [namespace endpoint ID](https://learn.microsoft.com/en-us/rest/api/eventhub/namespaces/get).
            For AWS CONFLUENT cluster, this is the [VPC Endpoint service name](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).
          type: string
        state:
          description: State the connection is in.
          readOnly: true
          type: string
        vendor:
          description: |-
            Vendor that manages the cloud service. The list of supported vendor values is:
            - AWS
            -- `MSK` for AWS MSK Kafka clusters
            -- `CONFLUENT` for Confluent Kafka clusters on AWS
            -- `KINESIS` for AWS Kinesis Data Streams

            - Azure
            -- `EVENTHUB` for Azure EventHub.
            -- `CONFLUENT` for Confluent Kafka clusters on Azure
            -- `AZURE_BLOB_STORAGE` for Azure Blob Storage

            - GCP
            -- `CONFLUENT` for Confluent Kafka clusters on GCP
            -- `PUBSUB` for Google Cloud Pub/Sub

            **NOTE** Omitting the vendor field will default to using the GENERIC vendor.
          type: string
      required:
      - provider
      type: object
    StreamsProcessor:
      description: An atlas stream processor.
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies the
            stream processor.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable name of the stream processor.
          type: string
        options:
          "$ref": "#/components/schemas/StreamsOptions"
        pipeline:
          description: Stream aggregation pipeline you want to apply to your streaming
            data.
          externalDocs:
            description: Supported Aggregation Pipeline Stages
            url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation
          items:
            "$ref": "#/components/schemas/Document"
          type: array
        tier:
          description: Selected tier for the Stream Workspace. Configures Memory /
            VCPU allowances.
          enum:
          - SP50
          - SP30
          - SP10
          - SP5
          - SP2
          title: Stream Workspace Tier
          type: string
      type: object
    StreamsProcessorWithStats:
      description: An atlas stream processor with optional stats.
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies the
            stream processor.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable name of the stream processor.
          readOnly: true
          type: string
        options:
          "$ref": "#/components/schemas/StreamsOptions"
        pipeline:
          description: Stream aggregation pipeline you want to apply to your streaming
            data.
          items:
            additionalProperties:
              readOnly: true
              type: object
            readOnly: true
            type: object
          readOnly: true
          type: array
        state:
          description: The state of the stream processor. Commonly occurring states
            are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.
          readOnly: true
          type: string
        stats:
          additionalProperties:
            description: The stats associated with the stream processor.
            externalDocs:
              url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor
            readOnly: true
            type: object
          description: The stats associated with the stream processor.
          externalDocs:
            url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor
          readOnly: true
          type: object
        tier:
          description: Selected tier for the Stream Workspace. Configures Memory /
            VCPU allowances.
          enum:
          - SP50
          - SP30
          - SP10
          - SP5
          - SP2
          title: Stream Workspace Tier
          type: string
      required:
      - _id
      - name
      - pipeline
      - state
      type: object
    StreamsPublicPrivateLinkNetworking:
      description: Networking configuration for connections that support `PUBLIC`
        and `PRIVATE_LINK` access types. For GCP connections, use `PRIVATE_LINK` for
        GCP Private Service Connect (PSC).
      properties:
        access:
          "$ref": "#/components/schemas/StreamsPublicPrivateLinkNetworkingAccess"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    StreamsPublicPrivateLinkNetworkingAccess:
      description: Information about networking access.
      properties:
        connectionId:
          description: The ID of the Private Link connection. Required for `PRIVATE_LINK`
            type. For GCP connections using Private Service Connect (PSC), this is
            the PSC connection ID.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        type:
          description: Selected networking type. Either `PUBLIC` or `PRIVATE_LINK`.
            Defaults to `PUBLIC`. For AWS, Azure, and GCP connections, use `PRIVATE_LINK`
            for AWS PrivateLink, Azure Private Link, or GCP Private Service Connect
            (PSC) respectively.
          enum:
          - PUBLIC
          - PRIVATE_LINK
          title: Networking Access Type
          type: string
      type: object
    StreamsS3Connection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          aws:
            "$ref": "#/components/schemas/StreamsAWSConnectionConfig"
          networking:
            "$ref": "#/components/schemas/StreamsKafkaNetworking"
        type: object
      description: The configuration for S3 connections.
      type: object
    StreamsSampleConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      type: object
    StreamsSampleConnections:
      description: Sample connections to add to SPI.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        solar:
          default: false
          description: Flag that indicates whether to add a `sample_stream_solar`
            connection.
          type: boolean
      type: object
    StreamsSchemaRegistryConnection:
      allOf:
      - "$ref": "#/components/schemas/StreamsConnection"
      - properties:
          provider:
            description: The Schema Registry provider.
            enum:
            - CONFLUENT
            type: string
          schemaRegistryAuthentication:
            "$ref": "#/components/schemas/SchemaRegistryAuthentication"
          schemaRegistryUrls:
            description: List of Schema Registry endpoint URLs used by this connection.
              Each URL must use the http or https scheme and specify a valid host
              and optional port.
            items:
              description: Schema Registry URL.
              format: uri
              type: string
            maxItems: 10
            type: array
            uniqueItems: true
        type: object
      description: The configuration for Schema Registry connections.
      required:
      - provider
      - schemaRegistryAuthentication
      - schemaRegistryUrls
      type: object
    StreamsStartStreamProcessorWith:
      description: A request to start a stream processor.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        resumeFromCheckpoint:
          description: When true or not specified, the stream processor resumes from
            its last checkpoint. When false, the stream processor starts fresh.
          type: boolean
        startAtOperationTime:
          description: The operation time after which the change stream source should
            begin reporting. This parameter expresses its value in the ISO 8601 timestamp
            format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        tier:
          description: Selected tier for the Stream Workspace. Configures Memory /
            VCPU allowances.
          enum:
          - SP50
          - SP30
          - SP10
          - SP5
          - SP2
          title: Stream Workspace Tier
          type: string
      type: object
    StreamsTenant:
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        connections:
          description: List of connections configured in the stream workspace.
          items:
            "$ref": "#/components/schemas/StreamsConnection"
          readOnly: true
          type: array
        dataProcessRegion:
          "$ref": "#/components/schemas/StreamsDataProcessRegion"
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnames:
          description: List that contains the hostnames assigned to the stream workspace.
          items:
            description: Unique hostname assigned to the stream workspace.
            readOnly: true
            type: string
          readOnly: true
          type: array
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Label that identifies the stream workspace.
          type: string
        sampleConnections:
          "$ref": "#/components/schemas/StreamsSampleConnections"
        streamConfig:
          "$ref": "#/components/schemas/StreamConfig"
      type: object
    StreamsTenantUpdateRequest:
      description: Details to update a stream tenant.
      properties:
        cloudProvider:
          description: Human-readable label that identifies the cloud provider.
          enum:
          - AWS
          - GCP
          - AZURE
          - TENANT
          - SERVERLESS
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        region:
          "$ref": "#/components/schemas/BaseStreamsRegion"
        streamConfig:
          "$ref": "#/components/schemas/StreamConfig"
      type: object
    SwapUsageFreeDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SwapUsageUsedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SynonymMappingStatusDetail:
      description: Contains the status of the index's synonym mappings on each search
        host. This field (and its subfields) only appear if the index has synonyms
        defined.
      properties:
        message:
          description: Optional message describing an error.
          type: string
        queryable:
          description: Flag that indicates whether the synonym mapping is queryable
            on a host.
          type: boolean
        status:
          description: Status that describes this index's synonym mappings. This status
            appears only if the index has synonyms defined.
          enum:
          - FAILED
          - BUILDING
          - READY
          type: string
      title: Synonym Mapping Status Detail
      type: object
    SynonymMappingStatusDetailMap:
      additionalProperties:
        "$ref": "#/components/schemas/SynonymMappingStatusDetail"
      type: object
      x-additionalPropertiesName: Synonym Mapping Name
    SynonymSource:
      description: Data set that stores words and their applicable synonyms.
      properties:
        collection:
          description: Label that identifies the MongoDB collection that stores words
            and their applicable synonyms.
          type: string
      required:
      - collection
      type: object
    SystemMemoryAvailableDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SystemMemoryPercentUsedRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    SystemMemoryUsedDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SystemNetworkInDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SystemNetworkOutDataMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/DataMetricUnits"
      required:
      - metricName
      type: object
    SystemStatus:
      properties:
        apiKey:
          "$ref": "#/components/schemas/ApiKey"
        appName:
          description: Human-readable label that identifies the service from which
            you requested this response.
          enum:
          - MongoDB Atlas
          readOnly: true
          type: string
        build:
          description: Unique 40-hexadecimal digit hash that identifies the latest
            git commit merged for this application.
          example: 83be55e140f493c88e7f578aae96548dd881587b
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        throttling:
          description: Flag that indicates whether someone enabled throttling on this
            service.
          readOnly: true
          type: boolean
      required:
      - apiKey
      - appName
      - build
      - throttling
      type: object
    TargetOrg:
      properties:
        linkToken:
          description: Link token that contains all the information required to complete
            the link.
          type: string
      required:
      - linkToken
      type: object
    TargetOrgRequest:
      properties:
        accessListIps:
          description: IP address access list entries associated with the API key.
          items:
            description: One IP address access list entry associated with the API
              key.
            type: string
          type: array
      type: object
    Team:
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies this team.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the team.
          type: string
        usernames:
          description: List that contains the MongoDB Cloud users in this team.
          items:
            format: email
            type: string
          type: array
          uniqueItems: true
      required:
      - name
      - usernames
      type: object
    TeamEvent:
      description: Team event identifies different activities around organization
        teams.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/TeamEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        teamId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            team associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Team Events
      type: object
    TeamEventTypeView:
      description: Unique identifier of event type.
      enum:
      - TEAM_CREATED
      - TEAM_DELETED
      - TEAM_UPDATED
      - TEAM_NAME_CHANGED
      - TEAM_ADDED_TO_GROUP
      - TEAM_REMOVED_FROM_GROUP
      - TEAM_ROLES_MODIFIED
      example: TEAM_ADDED_TO_GROUP
      title: Team Event Types
      type: string
    TeamEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - TEAM_ADDED_TO_GROUP
      - TEAM_REMOVED_FROM_GROUP
      - TEAM_ROLES_MODIFIED
      example: TEAM_ADDED_TO_GROUP
      title: Team Event Types
      type: string
    TeamEventViewForNdsGroup:
      description: Team event identifies different activities around organization
        teams.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/TeamEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        teamId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            team associated with this event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: Team Events
      type: object
    TeamNotification:
      description: Team notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        emailEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        smsEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        teamId:
          description: 'Unique 24-hexadecimal digit string that identifies one MongoDB
            Cloud team. The resource requires this parameter when `"notifications.[n].typeName"
            : "TEAM"`.'
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        teamName:
          description: 'Name of the MongoDB Cloud team that receives this notification.
            The resource requires this parameter when `"notifications.[n].typeName"
            : "TEAM"`.'
          example: Atlas
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - TEAM
          type: string
      required:
      - typeName
      title: Team Notification
      type: object
    TeamResponse:
      properties:
        id:
          description: Unique 24-hexadecimal digit string that identifies this team.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the team.
          type: string
      type: object
    TeamRole:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        roleNames:
          description: One or more project-level roles to assign to the team.
          externalDocs:
            description: MongoDB Cloud User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
        teamId:
          description: Unique 24-hexadecimal character string that identifies the
            team.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      required:
      - roleNames
      - teamId
      type: object
    TeamUpdate:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        name:
          description: Human-readable label that identifies the team.
          type: string
          writeOnly: true
      required:
      - name
      type: object
    TenantHardwareSpec20240805:
      properties:
        diskSizeGB:
          description: "Storage capacity of instance data volumes expressed in gigabytes.
            Increase this number to add capacity.\n\n This value must be equal for
            all shards and node types.\n\n This value is not configurable on M0/M2/M5
            clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n
            If you specify a disk size below the minimum (10 GB), this parameter defaults
            to the minimum disk size value. \n\n Storage charge calculations depend
            on whether you choose the default value or a custom value.\n\n The maximum
            value for disk storage cannot exceed 50 times the maximum RAM for the
            selected cluster. If you require more storage space, consider upgrading
            your cluster to a higher tier."
          externalDocs:
            description: Customize Storage
            url: https://dochub.mongodb.org/core/customize-storage
          format: double
          type: number
        effectiveInstanceSize:
          description: The true tenant instance size. This is present to support backwards
            compatibility for deprecated provider types and/or instance sizes.
          enum:
          - FLEX
          - M2
          - M5
          - M0
          readOnly: true
          type: string
        instanceSize:
          description: Hardware specification for the instances in this M0/M2/M5 tier
            cluster.
          enum:
          - M0
          - M2
          - M5
          title: Tenant Instance Sizes
          type: string
      type: object
    TenantRegionConfig20240805:
      allOf:
      - "$ref": "#/components/schemas/CloudRegionConfig20240805"
      - properties:
          backingProviderName:
            description: "Cloud service provider on which MongoDB Cloud provisioned
              the multi-tenant cluster. The resource returns this parameter when `providerName`
              is `TENANT` and `electableSpecs.instanceSize` is `M0`, `M2` or `M5`.
              \n\nPlease note that  using an `instanceSize` of `M2` or `M5` will create
              a Flex cluster instead. Support for the `instanceSize` of `M2` or `M5`
              will be discontinued in January 2026. We recommend using the Create
              Flex Cluster API for such configurations moving forward."
            enum:
            - AWS
            - GCP
            - AZURE
            externalDocs:
              description: Create Flex Cluster API
              url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
            type: string
        type: object
      description: Details that explain how MongoDB Cloud replicates data in one region
        on the specified MongoDB database.
      title: Tenant Regional Replication Specifications
      type: object
    TenantWithSampleConnections:
      type: object
    TextSearchHostStatusDetail:
      properties:
        hostname:
          description: Hostname that corresponds to the status detail.
          type: string
        mainIndex:
          "$ref": "#/components/schemas/TextSearchIndexStatusDetail"
        queryable:
          description: Flag that indicates whether the index is queryable on the host.
          type: boolean
        stagedIndex:
          "$ref": "#/components/schemas/TextSearchIndexStatusDetail"
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
      title: Text Search Host Status Detail
      type: object
    TextSearchIndexCreateRequest:
      allOf:
      - "$ref": "#/components/schemas/SearchIndexCreateRequest"
      - properties:
          definition:
            "$ref": "#/components/schemas/TextSearchIndexDefinition"
        type: object
      description: Text Search Index Create Request.
      required:
      - collectionName
      - database
      - definition
      - name
      type: object
    TextSearchIndexDefinition:
      description: The text search index definition set by the user.
      properties:
        analyzer:
          default: lucene.standard
          description: |-
            Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:

            - extracting words
            - removing punctuation
            - removing accents
            - changing to lowercase
            - removing common words
            - reducing words to their root form (stemming)
            - changing words to their base form (lemmatization)
             MongoDB Cloud uses the process you select to build the Atlas Search index.
          enum:
          - lucene.standard
          - lucene.simple
          - lucene.whitespace
          - lucene.keyword
          - lucene.arabic
          - lucene.armenian
          - lucene.basque
          - lucene.bengali
          - lucene.brazilian
          - lucene.bulgarian
          - lucene.catalan
          - lucene.chinese
          - lucene.cjk
          - lucene.czech
          - lucene.danish
          - lucene.dutch
          - lucene.english
          - lucene.finnish
          - lucene.french
          - lucene.galician
          - lucene.german
          - lucene.greek
          - lucene.hindi
          - lucene.hungarian
          - lucene.indonesian
          - lucene.irish
          - lucene.italian
          - lucene.japanese
          - lucene.korean
          - lucene.kuromoji
          - lucene.latvian
          - lucene.lithuanian
          - lucene.morfologik
          - lucene.nori
          - lucene.norwegian
          - lucene.persian
          - lucene.portuguese
          - lucene.romanian
          - lucene.russian
          - lucene.smartcn
          - lucene.sorani
          - lucene.spanish
          - lucene.swedish
          - lucene.thai
          - lucene.turkish
          - lucene.ukrainian
          externalDocs:
            description: Atlas Search Analyzers
            url: https://dochub.mongodb.org/core/analyzers--fts
          type: string
        analyzers:
          description: List of user-defined methods to convert database field text
            into searchable words.
          externalDocs:
            description: Custom Atlas Search Analyzers
            url: https://dochub.mongodb.org/core/custom-fts
          items:
            "$ref": "#/components/schemas/AtlasSearchAnalyzer"
          type: array
        mappings:
          "$ref": "#/components/schemas/SearchMappings"
        numPartitions:
          default: 1
          description: Number of index partitions. Allowed values are [1, 2, 4].
          format: int32
          type: integer
        searchAnalyzer:
          default: lucene.standard
          description: Method applied to identify words when searching this index.
          enum:
          - lucene.standard
          - lucene.simple
          - lucene.whitespace
          - lucene.keyword
          - lucene.arabic
          - lucene.armenian
          - lucene.basque
          - lucene.bengali
          - lucene.brazilian
          - lucene.bulgarian
          - lucene.catalan
          - lucene.chinese
          - lucene.cjk
          - lucene.czech
          - lucene.danish
          - lucene.dutch
          - lucene.english
          - lucene.finnish
          - lucene.french
          - lucene.galician
          - lucene.german
          - lucene.greek
          - lucene.hindi
          - lucene.hungarian
          - lucene.indonesian
          - lucene.irish
          - lucene.italian
          - lucene.japanese
          - lucene.korean
          - lucene.kuromoji
          - lucene.latvian
          - lucene.lithuanian
          - lucene.morfologik
          - lucene.nori
          - lucene.norwegian
          - lucene.persian
          - lucene.portuguese
          - lucene.romanian
          - lucene.russian
          - lucene.smartcn
          - lucene.sorani
          - lucene.spanish
          - lucene.swedish
          - lucene.thai
          - lucene.turkish
          - lucene.ukrainian
          type: string
        sort:
          description: 'Sort definition for the index. When defined, the index will
            be pre-sorted on the specified fields, which improves query sort performance
            for those fields. Supports two formats: simple format with field name
            and direction, or complex format with additional options. The `order`
            field is required (1=ascending, -1=descending).The `noData` field is optional
            and controls how missing values are sorted(default: "lowest").'
          example:
            anotherField:
              noData: highest
              order: -1
            fieldName: 1
          type: object
        storedSource:
          description: Flag that indicates whether to store all fields (true) on Atlas
            Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively,
            you can specify an object that only contains the list of fields to store
            (include) or not store (exclude) on Atlas Search. Note that storing all
            fields (true) is not allowed for vector search indexes. To learn more,
            see Stored Source Fields.
          example:
            include | exclude:
            - field1
            - field2
          externalDocs:
            description: Stored Source Fields
            url: https://dochub.mongodb.org/core/atlas-search-stored-source
          type: object
        synonyms:
          description: Rule sets that map words to their synonyms in this index.
          externalDocs:
            description: Synonym Mapping
            url: https://dochub.mongodb.org/core/fts-synonym-mappings
          items:
            "$ref": "#/components/schemas/SearchSynonymMappingDefinition"
          type: array
        typeSets:
          description: Type sets for the index.
          items:
            "$ref": "#/components/schemas/SearchTypeSets"
          maxItems: 100
          type: array
      required:
      - mappings
      title: Text Search Index Definition
      type: object
    TextSearchIndexResponse:
      allOf:
      - "$ref": "#/components/schemas/SearchIndexResponse"
      - properties:
          latestDefinition:
            "$ref": "#/components/schemas/TextSearchIndexDefinition"
          statusDetail:
            description: List of documents detailing index status on each host.
            items:
              "$ref": "#/components/schemas/TextSearchHostStatusDetail"
            type: array
          synonymMappingStatus:
            description: Status that describes this index's synonym mappings. This
              status appears only if the index has synonyms defined.
            enum:
            - FAILED
            - BUILDING
            - READY
            type: string
          synonymMappingStatusDetail:
            description: A list of documents describing the status of the index's
              synonym mappings on each search host. Only appears if the index has
              synonyms defined.
            items:
              additionalProperties:
                "$ref": "#/components/schemas/SynonymMappingStatusDetail"
              type: object
            type: array
        type: object
      title: Text Search Index Response
      type: object
    TextSearchIndexStatusDetail:
      description: Contains status information about a text search index.
      properties:
        definition:
          "$ref": "#/components/schemas/TextSearchIndexDefinition"
        definitionVersion:
          "$ref": "#/components/schemas/SearchIndexDefinitionVersion"
        message:
          description: Optional message describing an error.
          type: string
        queryable:
          description: Flag that indicates whether the index generation is queryable
            on the host.
          type: boolean
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
        synonymMappingStatus:
          description: Status that describes this index's synonym mappings. This status
            appears only if the index has synonyms defined.
          enum:
          - FAILED
          - BUILDING
          - READY
          type: string
        synonymMappingStatusDetail:
          description: List of synonym statuses by mapping.
          items:
            "$ref": "#/components/schemas/SynonymMappingStatusDetailMap"
          type: array
      title: Text Search Index Status Detail
      type: object
    ThirdPartyIntegration:
      description: Collection of settings that describe third-party integrations.
      discriminator:
        mapping:
          DATADOG: "#/components/schemas/Datadog"
          MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams"
          NEW_RELIC: "#/components/schemas/NewRelic"
          OPS_GENIE: "#/components/schemas/OpsGenie"
          PAGER_DUTY: "#/components/schemas/PagerDuty"
          PROMETHEUS: "#/components/schemas/Prometheus"
          SLACK: "#/components/schemas/Slack"
          VICTOR_OPS: "#/components/schemas/VictorOps"
          WEBHOOK: "#/components/schemas/Webhook"
        propertyName: type
      oneOf:
      - "$ref": "#/components/schemas/PagerDuty"
      - "$ref": "#/components/schemas/Slack"
      - "$ref": "#/components/schemas/Datadog"
      - "$ref": "#/components/schemas/NewRelic"
      - "$ref": "#/components/schemas/OpsGenie"
      - "$ref": "#/components/schemas/VictorOps"
      - "$ref": "#/components/schemas/Webhook"
      - "$ref": "#/components/schemas/Prometheus"
      - "$ref": "#/components/schemas/MicrosoftTeams"
      properties:
        id:
          description: Integration id.
          nullable: true
          type: string
        type:
          description: Integration type.
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
          type: string
      title: Third-Party Integration
      type: object
    TicketsAvailableReadsRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    TicketsAvailableWritesRawMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/RawMetricUnits"
      required:
      - metricName
      type: object
    TimeMetricAlertView:
      properties:
        acknowledgedUntil:
          description: |-
            Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 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, do not set this parameter value.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
        acknowledgementComment:
          description: Comment that a MongoDB Cloud user submitted when acknowledging
            the alert.
          example: Expiration on 3/19.  Silencing for 7days.
          maxLength: 200
          type: string
        acknowledgingUsername:
          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.
          format: email
          readOnly: true
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration that sets this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        clusterName:
          description: Human-readable label that identifies the cluster to which this
            alert applies. This resource returns this parameter for alerts of events
            impacting backups, replica sets, or sharded clusters.
          example: cluster1
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          readOnly: true
          type: string
        created:
          description: Date and time when MongoDB Cloud created this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/TimeMetricValueView"
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            that owns this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        hostnameAndPort:
          description: Hostname and port of the host to which this alert applies.
            The resource returns this parameter for alerts of events impacting hosts
            or replica sets.
          example: cloud-test.mongodb.com:27017
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies this alert.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        lastNotified:
          description: Date and time that any notifications were last sent for this
            alert. This parameter expresses its value in the ISO 8601 timestamp format
            in UTC. The resource returns this parameter if MongoDB Cloud has sent
            notifications for this alert.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: |-
            Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.

            To learn more about the available metrics, see <a href="https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types" target="_blank">Host Metrics</a>.

            **NOTE**: If you set `eventTypeName` to `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, you can specify only metrics available for serverless. To learn more, see <a href="https://dochub.mongodb.org/core/alert-config-serverless-measurements" target="_blank">Serverless Measurements</a>.
          example: ASSERT_USER
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal character string that identifies the
            organization that owns the project to which this alert applies.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        replicaSetName:
          description: Name of the replica set to which this alert applies. The response
            returns this parameter for alerts of events impacting backups, hosts,
            or replica sets.
          example: event-replica-set
          readOnly: true
          type: string
        resolved:
          description: 'Date and time that this alert changed to `"status" : "CLOSED"`.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC. The resource returns this parameter once `"status" : "CLOSED"`.'
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        status:
          description: State of this alert at the time you requested its details.
            TRACKING indicates the alert condition exists but has not persisted for
            the minimum notification delay. OPEN indicates the alert condition currently
            exists. CLOSED indicates the alert condition has been resolved.
          enum:
          - CANCELLED
          - CLOSED
          - OPEN
          - TRACKING
          example: OPEN
          readOnly: true
          type: string
        updated:
          description: Date and time when someone last updated this alert. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
      required:
      - alertConfigId
      - created
      - eventTypeName
      - id
      - status
      - updated
      type: object
    TimeMetricEventView:
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        currentValue:
          "$ref": "#/components/schemas/TimeMetricValueView"
        deskLocation:
          description: Desk location of MongoDB employee associated with the event.
          readOnly: true
          type: string
        employeeIdentifier:
          description: Identifier of MongoDB employee associated with the event.
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/HostMetricEventTypeView"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        metricName:
          description: Human-readable label of the metric associated with the `alertId`.
            This field may change type of `currentValue` field.
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        port:
          description: IANA port on which the MongoDB process listens for requests.
          example: 27017
          format: int32
          readOnly: true
          type: integer
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        replicaSetName:
          description: Human-readable label of the replica set associated with the
            event.
          example: event-replica-set
          readOnly: true
          type: string
        shardName:
          description: Human-readable label of the shard associated with the event.
          example: event-sh-01
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      type: object
    TimeMetricThresholdView:
      properties:
        metricName:
          description: Human-readable label that identifies the metric against which
            MongoDB Cloud checks the configured `metricThreshold.threshold`.
          type: string
        mode:
          description: MongoDB Cloud computes the current metric value as an average.
          enum:
          - AVERAGE
          type: string
        operator:
          description: Comparison operator to apply when checking the current metric
            value.
          enum:
          - LESS_THAN
          - GREATER_THAN
          type: string
        threshold:
          description: Value of metric that, when exceeded, triggers an alert.
          format: double
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      required:
      - metricName
      type: object
    TimeMetricUnits:
      default: HOURS
      description: Element used to express the quantity. This can be an element of
        time, storage capacity, and the like.
      enum:
      - NANOSECONDS
      - MILLISECONDS
      - MILLION_MINUTES
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      title: Time Metric Units
      type: string
    TimeMetricValueView:
      description: Measurement of the `metricName` recorded at the time of the event.
      properties:
        number:
          description: Amount of the `metricName` recorded at the time of the event.
            This value triggered the alert.
          format: double
          readOnly: true
          type: number
        units:
          "$ref": "#/components/schemas/TimeMetricUnits"
      readOnly: true
      title: Time Metric Value
      type: object
    TokenFilterEnglishPossessive:
      description: Filter that removes possessives (trailing 's) from words.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - englishPossessive
          type: string
      required:
      - type
      title: englishPossessive
      type: object
    TokenFilterFlattenGraph:
      description: Filter that transforms a token filter graph, such as the token
        filter graph that the `wordDelimiterGraph` token filter produces, into a flat
        form suitable for indexing.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - flattenGraph
          type: string
      required:
      - type
      title: flattenGraph
      type: object
    TokenFilterPorterStemming:
      description: Filter that uses the porter stemming algorithm to remove the common
        morphological and inflectional suffixes from words in English. It expects
        lowercase text and doesn't work as expected for uppercase text.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - porterStemming
          type: string
      required:
      - type
      title: porterStemming
      type: object
    TokenFilterSpanishPluralStemming:
      description: Filter that stems Spanish plural words. It expects lowercase text.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - spanishPluralStemming
          type: string
      required:
      - type
      title: spanishPluralStemming
      type: object
    TokenFilterStempel:
      description: Filter that uses Lucene's default Polish stemmer table to stem
        words in the Polish language. It expects lowercase text.
      externalDocs:
        description: Default Polish stemmer table
        url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - stempel
          type: string
      required:
      - type
      title: stempel
      type: object
    TokenFilterWordDelimiterGraph:
      description: Filter that splits tokens into sub-tokens based on configured rules.
      properties:
        delimiterOptions:
          description: Object that contains the rules that determine how to split
            words into sub-words.
          properties:
            concatenateAll:
              default: false
              description: Flag that indicates whether to concatenate runs.
              type: boolean
            concatenateNumbers:
              default: false
              description: Flag that indicates whether to concatenate runs of sub-numbers.
              type: boolean
            concatenateWords:
              default: false
              description: Flag that indicates whether to concatenate runs of sub-words.
              type: boolean
            generateNumberParts:
              default: true
              description: Flag that indicates whether to split tokens based on sub-numbers.
                For example, if `true`, this option splits `100-2` into `100` and
                `2`.
              type: boolean
            generateWordParts:
              default: true
              description: Flag that indicates whether to split tokens based on sub-words.
              type: boolean
            ignoreKeywords:
              default: false
              description: Flag that indicates whether to skip tokens with the `keyword`
                attribute set to `true`.
              type: boolean
            preserveOriginal:
              default: true
              description: Flag that indicates whether to generate tokens of the original
                words.
              type: boolean
            splitOnCaseChange:
              default: true
              description: Flag that indicates whether to split tokens based on letter-case
                transitions.
              type: boolean
            splitOnNumerics:
              default: true
              description: Flag that indicates whether to split tokens based on letter-number
                transitions.
              type: boolean
            stemEnglishPossessive:
              default: true
              description: Flag that indicates whether to remove trailing possessives
                from each sub-word.
              type: boolean
          type: object
        protectedWords:
          description: Object that contains options for protected words.
          properties:
            ignoreCase:
              default: true
              description: Flag that indicates whether to ignore letter case sensitivity
                for protected words.
              type: boolean
            words:
              description: List that contains the tokens to protect from delimination.
              items:
                type: string
              type: array
          required:
          - words
          type: object
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - wordDelimiterGraph
          type: string
      required:
      - type
      title: wordDelimiterGraph
      type: object
    TokenFilterkStemming:
      description: Filter that combines algorithmic stemming with a built-in dictionary
        for the English language to stem words.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - kStemming
          type: string
      required:
      - type
      title: kStemming
      type: object
    TriggerIngestionPipelineRequest:
      properties:
        datasetRetentionPolicy:
          "$ref": "#/components/schemas/DatasetRetentionPolicy"
        snapshotId:
          description: Unique 24-hexadecimal character string that identifies the
            snapshot.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
          writeOnly: true
      required:
      - snapshotId
      type: object
    UpdateAtlasOrganizationApiKey:
      properties:
        desc:
          description: Purpose or explanation provided when someone creates this organization
            API key.
          maxLength: 250
          minLength: 1
          type: string
        roles:
          description: List of roles to grant this API key. If you provide this list,
            provide a minimum of one role and ensure each role applies to this organization.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          type: array
      type: object
    UpdateAtlasProjectApiKey:
      properties:
        desc:
          description: Purpose or explanation provided when someone creates this project
            API key.
          maxLength: 250
          minLength: 1
          type: string
        roles:
          description: List of roles to grant this API key. If you provide this list,
            provide a minimum of one role and ensure each role applies to this project.
          externalDocs:
            description: MongoDB Cloud API Key Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
      type: object
    UpdateCustomDBRole:
      properties:
        actions:
          description: List of the individual privilege actions that the role grants.
          items:
            "$ref": "#/components/schemas/DatabasePrivilegeAction"
          type: array
        inheritedRoles:
          description: List of the built-in roles that this custom role inherits.
          items:
            "$ref": "#/components/schemas/DatabaseInheritedRole"
          type: array
          uniqueItems: true
      type: object
    UpdateGroupRolesForUser:
      properties:
        groupRoles:
          description: One or more project-level roles to assign to the MongoDB Cloud
            user.
          externalDocs:
            description: MongoDB Atlas User Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
          uniqueItems: true
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    UpdateOrgRolesForUser:
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgRoles:
          description: One or more organization level roles to assign to the MongoDB
            Cloud user.
          items:
            enum:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_GROUP_CREATOR
            - ORG_BILLING_ADMIN
            - ORG_BILLING_READ_ONLY
            - ORG_STREAM_PROCESSING_ADMIN
            - ORG_READ_ONLY
            type: string
          type: array
          uniqueItems: true
      type: object
    UpdateRequirePrivateNetworkingRequestView:
      description: Request body to toggle the private-networking requirement for an
        existing export bucket.
      properties:
        requirePrivateNetworking:
          description: True to require private networking; false to disable it.
          type: boolean
      required:
      - requirePrivateNetworking
      type: object
    UsageDetailsFilterRequest:
      description: Request body which contains various fields to filter line items
        as part of certain Invoice Usage Details queries.
      properties:
        billEndDate:
          description: The inclusive billing start date for usage details filter.
          format: date
          type: string
        billStartDate:
          description: The inclusive billing start date for usage details filter.
          format: date
          type: string
        clusterIds:
          description: The list of unique cluster ids to be included in the Usage
            Details filter.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          type: array
          uniqueItems: true
        groupIds:
          description: The list of groups to be included in the Usage Details filter.
          items:
            example: 32b6e34b3d91647abb20e7b8
            pattern: "^([a-f0-9]{24})$"
            type: string
          type: array
          uniqueItems: true
        includeZeroCentLineItems:
          description: Whether zero cent line items should be included.
          type: boolean
        skuServices:
          description: The list of projects to be included in the Cost Explorer Query.
          items:
            enum:
            - Atlas
            - Clusters
            - Storage
            - Serverless Instances
            - Backup
            - Data Transfer
            - BI Connector
            - DSC Compute
            - DSC Storage
            - Premium Features
            - Atlas Data Federation
            - Atlas Stream Processing
            - App Services
            - Charts
            - Cloud Manager
            - Cloud Manager Standard/Premium
            - Legacy Backup
            - AI Models
            - Automated Embedding
            - Native Reranking
            - Flex Consulting
            - Support
            - Credits
            type: string
          type: array
          uniqueItems: true
        usageEndDate:
          description: The inclusive billing start date for usage details filter.
          format: date
          type: string
        usageStartDate:
          description: The inclusive usage start date for usage details filter.
          format: date
          type: string
      type: object
    UserAccessListRequest:
      properties:
        cidrBlock:
          description: Range of network addresses that you want to add to the access
            list for the API key. This parameter requires the range to be expressed
            in classless inter-domain routing (CIDR) notation of Internet Protocol
            version 4 or version 6 addresses. You can set a value for this parameter
            or `ipAddress` but not both in the same request.
          example: 203.0.113.0/24
          pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
          type: string
        ipAddress:
          description: Network address that you want to add to the access list for
            the API key. This parameter requires the address to be expressed as one
            Internet Protocol version 4 or version 6 address. You can set a value
            for this parameter or `cidrBlock` but not both in the same request.
          example: 203.0.113.10
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
      type: object
    UserAccessListResponse:
      properties:
        cidrBlock:
          description: Range of IP addresses in Classless Inter-Domain Routing (CIDR)
            notation in the access list for the API key.
          example: 203.0.113.0/24
          pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$"
          type: string
        count:
          description: Total number of requests that have originated from the Internet
            Protocol (IP) address given as the value of the `lastUsedAddress` parameter.
          format: int32
          minimum: 1
          readOnly: true
          type: integer
        created:
          description: Date and time when someone added the network addresses to the
            specified API access list. This parameter expresses its value in the ISO
            8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        ipAddress:
          description: Network address in the access list for the API key.
          example: 203.0.113.10
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
        lastUsed:
          description: Date and time when MongoDB Cloud received the most recent request
            that originated from this Internet Protocol version 4 or version 6 address.
            The resource returns this parameter when at least one request has originated
            from this IP address. MongoDB Cloud updates this parameter each time a
            client accesses the permitted resource. This parameter expresses its value
            in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        lastUsedAddress:
          description: Network address that issued the most recent request to the
            API. This parameter requires the address to be expressed as one Internet
            Protocol version 4 or version 6 address. The resource returns this parameter
            after this IP address made at least one request.
          example: 203.0.113.10
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    UserAccessRoleAssignment:
      properties:
        roles:
          description: List of roles to grant this API key. If you provide this list,
            provide a minimum of one role and ensure each role applies to this project.
          externalDocs:
            description: MongoDB Cloud API Key Roles
            url: https://www.mongodb.com/docs/atlas/reference/user-roles/
          items:
            type: string
          type: array
        userId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            API key.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      type: object
    UserCert:
      properties:
        _id:
          description: Unique 24-hexadecimal character string that identifies this
            certificate.
          format: int64
          readOnly: true
          type: integer
        createdAt:
          description: Date and time when MongoDB Cloud created this certificate.
            This parameter expresses its value in the ISO 8601 timestamp format in
            UTC.
          format: date-time
          readOnly: true
          type: string
        groupId:
          description: Unique 24-hexadecimal character string that identifies the
            project.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        monthsUntilExpiration:
          default: 3
          description: Number of months that the certificate remains valid until it
            expires.
          format: int32
          maximum: 24
          type: integer
          writeOnly: true
        notAfter:
          description: Date and time when this certificate expires. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          readOnly: true
          type: string
        subject:
          description: Subject Alternative Name associated with this certificate.
            This parameter expresses its value as a distinguished name as defined
            in RFC 2253.
          example: CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com
          externalDocs:
            description: RFC 2253
            url: https://tools.ietf.org/html/2253
          pattern: "^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$"
          readOnly: true
          type: string
      type: object
    UserCustomDBRole:
      properties:
        actions:
          description: List of the individual privilege actions that the role grants.
          items:
            "$ref": "#/components/schemas/DatabasePrivilegeAction"
          type: array
        inheritedRoles:
          description: List of the built-in roles that this custom role inherits.
          items:
            "$ref": "#/components/schemas/DatabaseInheritedRole"
          type: array
          uniqueItems: true
        roleName:
          description: Human-readable label that identifies the role for the request.
            This name must be unique for this custom role in this project.
          type: string
      required:
      - roleName
      type: object
    UserEventTypeViewForNdsGroup:
      description: Unique identifier of event type.
      enum:
      - JOINED_GROUP
      - REMOVED_FROM_GROUP
      - INVITED_TO_GROUP
      - REQUESTED_TO_JOIN_GROUP
      - GROUP_INVITATION_DELETED
      - USER_ROLES_CHANGED_AUDIT
      - JOIN_GROUP_REQUEST_DENIED_AUDIT
      - JOIN_GROUP_REQUEST_APPROVED_AUDIT
      example: JOINED_GROUP
      title: User Event Types
      type: string
    UserEventTypeViewForOrg:
      description: Unique identifier of event type.
      enum:
      - JOINED_ORG
      - JOINED_TEAM
      - INVITED_TO_ORG
      - ORG_INVITATION_DELETED
      - REMOVED_FROM_ORG
      - REMOVED_FROM_TEAM
      - USER_ROLES_CHANGED_AUDIT
      - ORG_FLEX_CONSULTING_PURCHASED
      - ORG_FLEX_CONSULTING_PURCHASE_FAILED
      - INVITED_TO_TEAM
      example: JOINED_ORG
      title: User Event Types
      type: string
    UserEventViewForNdsGroup:
      description: User event reflects different activities about the atlas user.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/UserEventTypeViewForNdsGroup"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        targetUsername:
          description: 'Email address for the console user that this event targets.
            The resource returns this parameter when `"eventTypeName" : "USER"`.'
          example: test.user@mongodb.com
          format: email
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: User Events
      type: object
    UserEventViewForOrg:
      description: User event reflects different activities about the atlas user.
      properties:
        apiKeyId:
          description: Unique 24-hexadecimal digit string that identifies the API
            Key that triggered the event. If this resource returns this parameter,
            it doesn't return the `userId` parameter.
          example: 32b6e34b3d91647abb20e7b8
          externalDocs:
            description: Create Programmatic API Key
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        created:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        eventTypeName:
          "$ref": "#/components/schemas/UserEventTypeViewForOrg"
        groupId:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred. The `eventId` identifies the specific event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        isGlobalAdmin:
          description: Flag that indicates whether a MongoDB employee triggered the
            specified event.
          readOnly: true
          type: boolean
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        publicKey:
          description: Public part of the API key that triggered the event. If this
            resource returns this parameter, it doesn't return the **username** parameter.
          externalDocs:
            url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
          readOnly: true
          type: string
        raw:
          "$ref": "#/components/schemas/raw"
        remoteAddress:
          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
          type: string
        targetUsername:
          description: 'Email address for the console user that this event targets.
            The resource returns this parameter when `"eventTypeName" : "USER"`.'
          example: test.user@mongodb.com
          format: email
          readOnly: true
          type: string
        userId:
          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
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        username:
          description: Email address for the user who triggered this event. If this
            resource returns this parameter, it doesn't return the `publicApiKey`
            parameter.
          format: email
          readOnly: true
          type: string
      required:
      - created
      - eventTypeName
      - id
      title: User Events
      type: object
    UserNotification:
      description: User notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        emailEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        smsEnabled:
          description: |-
            Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:

            - `"notifications.[n].typeName" : "ORG"`
            - `"notifications.[n].typeName" : "GROUP"`
            - `"notifications.[n].typeName" : "USER"`
          type: boolean
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - USER
          type: string
        username:
          description: 'MongoDB Cloud username of the person to whom MongoDB Cloud
            sends notifications. Specify only MongoDB Cloud users who belong to the
            project that owns the alert configuration. The resource requires this
            parameter when `"notifications.[n].typeName" : "USER"`.'
          format: email
          type: string
      required:
      - typeName
      title: User Notification
      type: object
    UserScope:
      description: Range of resources available to this database user.
      properties:
        name:
          description: Human-readable label that identifies the cluster or MongoDB
            Atlas Data Lake that this database user can access.
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
        type:
          description: Category of resource that this database user can access.
          enum:
          - CLUSTER
          - DATA_LAKE
          - STREAM
          type: string
      required:
      - name
      - type
      title: Database User Scope
      type: object
    UserSecurity:
      properties:
        customerX509:
          "$ref": "#/components/schemas/DBUserTLSX509Settings"
        ldap:
          "$ref": "#/components/schemas/LDAPSecuritySettings"
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
      type: object
    UserToDNMapping:
      description: User-to-Distinguished Name (DN) map that MongoDB Cloud uses to
        transform a Lightweight Directory Access Protocol (LDAP) username into an
        LDAP DN.
      properties:
        ldapQuery:
          description: Lightweight Directory Access Protocol (LDAP) query template
            that inserts the LDAP name that the regular expression matches into an
            LDAP query Uniform Resource Identifier (URI). The formatting for the query
            must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515)
            and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).
          type: string
        match:
          description: Regular expression that MongoDB Cloud uses to match against
            the provided Lightweight Directory Access Protocol (LDAP) username. Each
            parenthesis-enclosed section represents a regular expression capture group
            that the substitution or `ldapQuery` template uses.
          example: "(.*)"
          type: string
        substitution:
          description: Lightweight Directory Access Protocol (LDAP) Distinguished
            Name (DN) template that converts the LDAP username that matches regular
            expression in the *match* parameter into an LDAP Distinguished Name (DN).
          example: CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com
          type: string
      required:
      - match
      title: User to Distinguished Name Mapping
      type: object
    VPCPeeringActionChallenge:
      description: Container for elements used to challenge the user before taking
        certain actions on VPC Peering connections.
      properties:
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        requesterAccountId:
          description: The AWS requester account ID.
          type: string
        requesterVpcId:
          description: The AWS requester VPC ID.
          type: string
      type: object
    VPCPeeringConnection:
      description: Represents a VPC Peering connection on AWS.
      properties:
        _id:
          description: Internal VPC Peering Connection ID.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        accepterAccountId:
          description: The account ID responsible for accepting the request.
          type: string
        accepterCidr:
          description: The CIDR block for the accepter VPC.
          type: string
        accepterVpcId:
          description: The VPC ID accepting the request.
          type: string
        cloudStatus:
          description: The status in the cloud provider for this connection.
          type: string
        expirationTime:
          description: The time when the VPC Peering Connection request expires. This
            parameter expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        groupId:
          description: The internal project ID.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        links:
          description: List of one or more Uniform Resource Locators (URLs) that point
            to API sub-resources, related API resources, or both. RFC 5988 outlines
            these relationships.
          externalDocs:
            description: Web Linking Specification (RFC 5988)
            url: https://datatracker.ietf.org/doc/html/rfc5988
          items:
            "$ref": "#/components/schemas/Link"
          readOnly: true
          type: array
        localStatus:
          description: The local status of the VPC Peering Connection.
          enum:
          - NONE
          - SCAN_FAILED
          - UPDATE_FAILED
          - REQUEST_ACCEPT
          - ACCEPT_REQUESTED
          - REQUEST_REJECT
          - REJECT_REQUESTED
          - REQUEST_DELETE
          - DELETE_REQUESTED
          - ACTIVE
          type: string
        name:
          description: Unique VPC Peering Connection name.
          type: string
        requesterAccountId:
          description: The account ID requesting the VPC Peering connection.
          type: string
        requesterCidr:
          description: The CIDR block for the requesting VPC.
          type: string
        requesterVpcId:
          description: The VPC ID requesting the VPC Peering connection.
          type: string
        statusMessage:
          description: A status message.
          type: string
      type: object
    VectorSearchHostStatusDetail:
      properties:
        hostname:
          description: Hostname that corresponds to the status detail.
          type: string
        mainIndex:
          "$ref": "#/components/schemas/VectorSearchIndexStatusDetail"
        queryable:
          description: Flag that indicates whether the index is queryable on the host.
          type: boolean
        stagedIndex:
          "$ref": "#/components/schemas/VectorSearchIndexStatusDetail"
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
      title: Vector Search Host Status Detail
      type: object
    VectorSearchIndex:
      allOf:
      - "$ref": "#/components/schemas/ClusterSearchIndex"
      - properties:
          fields:
            description: Settings that configure the fields, one per object, to index.
              You must define at least one "vector" type field. You can optionally
              define "filter" type fields also.
            externalDocs:
              description: Vector Search Fields
              url: https://dochub.mongodb.org/core/avs-vector-type
            items:
              "$ref": "#/components/schemas/BasicDBObject"
            type: array
          nestedRoot:
            description: Top-level path to the array that contains vector fields.
              When provided, vector fields under this path are treated as nested.
            example: sections
            type: string
        type: object
      required:
      - collectionName
      - database
      - name
      type: object
    VectorSearchIndexCreateRequest:
      allOf:
      - "$ref": "#/components/schemas/SearchIndexCreateRequest"
      - properties:
          definition:
            "$ref": "#/components/schemas/VectorSearchIndexDefinition"
        type: object
      description: Vector Search Index Create Request.
      required:
      - collectionName
      - database
      - definition
      - name
      type: object
    VectorSearchIndexDefinition:
      description: The vector search index definition set by the user.
      properties:
        fields:
          description: Settings that configure the fields, one per object, to index.
            You must define at least one "vector" type field. You can optionally define
            "filter" type fields also.
          externalDocs:
            description: Vector Search Fields
            url: https://dochub.mongodb.org/core/avs-vector-type
          items:
            "$ref": "#/components/schemas/BasicDBObject"
          type: array
        nestedRoot:
          description: Top-level path to the array that contains vector fields. When
            provided, vector fields under this path are treated as nested.
          example: sections
          type: string
        numPartitions:
          default: 1
          description: Number of index partitions. Allowed values are [1, 2, 4].
          format: int32
          type: integer
        storedSource:
          description: Flag that indicates whether to store all fields (true) on Atlas
            Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively,
            you can specify an object that only contains the list of fields to store
            (include) or not store (exclude) on Atlas Search. Note that storing all
            fields (true) is not allowed for vector search indexes. To learn more,
            see Stored Source Fields.
          example:
            include | exclude:
            - field1
            - field2
          externalDocs:
            description: Stored Source Fields
            url: https://dochub.mongodb.org/core/atlas-search-stored-source
          type: object
      required:
      - fields
      title: Vector Search Index Definition
      type: object
    VectorSearchIndexResponse:
      allOf:
      - "$ref": "#/components/schemas/SearchIndexResponse"
      - properties:
          latestDefinition:
            "$ref": "#/components/schemas/VectorSearchIndexDefinition"
          statusDetail:
            description: List of documents detailing index status on each host.
            items:
              "$ref": "#/components/schemas/VectorSearchHostStatusDetail"
            type: array
        type: object
      title: Vector Search Index Response
      type: object
    VectorSearchIndexStatusDetail:
      description: Contains status information about a vector search index.
      properties:
        definition:
          "$ref": "#/components/schemas/VectorSearchIndexDefinition"
        definitionVersion:
          "$ref": "#/components/schemas/SearchIndexDefinitionVersion"
        message:
          description: Optional message describing an error.
          type: string
        queryable:
          description: Flag that indicates whether the index generation is queryable
            on the host.
          type: boolean
        status:
          description: |-
            Condition of the search index when you made this request.

            - `DELETING`: The index is being deleted.
            - `FAILED` The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
            - `STALE`: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
            - `PENDING`: Atlas has not yet started building the index.
            - `BUILDING`: Atlas is building or re-building the index after an edit.
            - `READY`: The index is ready and can support queries.
          enum:
          - DELETING
          - FAILED
          - STALE
          - PENDING
          - BUILDING
          - READY
          - DOES_NOT_EXIST
          type: string
      title: Vector Search Index Status Detail
      type: object
    VictorOps:
      description: Details to integrate one Splunk On-Call account with one MongoDB
        Cloud project.
      properties:
        apiKey:
          description: |-
            Key that allows MongoDB Cloud to access your VictorOps account.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "********************************9abc"
          type: string
        id:
          description: Integration id.
          nullable: true
          type: string
        routingKey:
          description: Routing key associated with your Splunk On-Call account.
          example: test routing
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - VICTOR_OPS
          type: string
      required:
      - apiKey
      title: VICTOR_OPS
      type: object
    VictorOpsNotification:
      description: VictorOps notification configuration for MongoDB Cloud to send
        information when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - VICTOR_OPS
          type: string
        victorOpsApiKey:
          description: |-
            API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `"notifications.[n].typeName" : "VICTOR_OPS"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.

            **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:

            * View or edit the alert through the Atlas UI.

            * Query the alert for the notification through the Atlas Administration API.
          example: "********************************9abc"
          type: string
        victorOpsRoutingKey:
          description: 'Routing key that MongoDB Cloud needs to send alert notifications
            to Splunk On-Call. The resource requires this parameter when `"notifications.[n].typeName"
            : "VICTOR_OPS"`. If the key later becomes invalid, MongoDB Cloud sends
            an email to the project owners. If the key remains invalid, MongoDB Cloud
            removes it.'
          example: test routing
          type: string
      required:
      - typeName
      title: VictorOps Notification
      type: object
    Webhook:
      description: Details to integrate one webhook with one MongoDB Cloud project.
      properties:
        id:
          description: Integration id.
          nullable: true
          type: string
        secret:
          description: |-
            An optional field returned if your webhook is configured with a secret.

            **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
          format: password
          type: string
        type:
          description: Human-readable label that identifies the service to which you
            want to integrate with MongoDB Cloud. The value must match the third-party
            service integration type.
          enum:
          - WEBHOOK
          type: string
        url:
          description: |-
            Endpoint web address to which MongoDB Cloud sends notifications.

            **NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.
          example: https://webhook.com/****
          type: string
      required:
      - url
      title: WEBHOOK
      type: object
    WebhookNotification:
      description: Webhook notification configuration for MongoDB Cloud to send information
        when an event triggers an alert condition.
      properties:
        delayMin:
          description: Number of minutes that MongoDB Cloud waits after detecting
            an alert condition before it sends out the first notification.
          format: int32
          type: integer
        integrationId:
          description: The id of the associated integration, the credentials of which
            to use for requests.
          example: 32b6e34b3d91647abb20e7b8
          type: string
        intervalMin:
          description: |-
            Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.

            PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
          format: int32
          minimum: 5
          type: integer
        notifierId:
          description: The `notifierId` is a system-generated unique identifier assigned
            to each notification method. This is needed when updating third-party
            notifications without requiring explicit authentication credentials.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
        typeName:
          description: Human-readable label that displays the alert notification type.
          enum:
          - WEBHOOK
          type: string
        webhookSecret:
          description: |-
            Authentication secret for a webhook-based alert.

            Atlas returns this value if you set `notifications.[n].typeName` :`WEBHOOK` and either:
            * You set `notification.[n].webhookSecret` to a non-empty string
            * You set a default webhook secret either on the Integrations page, or with the Integrations API

            **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
          externalDocs:
            description: Integrations page
            url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations
          format: password
          type: string
        webhookUrl:
          description: |-
            Target URL for a webhook-based alert.

            Atlas returns this value if you set `"notifications.[n].typeName" :"WEBHOOK"` and either:
            * You set `notification.[n].webhookURL` to a non-empty string
            * You set a default webhook URL either on the Integrations page, or with the Integrations API

            **NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
          example: https://webhook.com/****
          externalDocs:
            description: Integrations page
            url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations
          type: string
      required:
      - typeName
      title: Webhook Notification
      type: object
    WeeklyScheduleView:
      allOf:
      - "$ref": "#/components/schemas/OnlineArchiveSchedule"
      - properties:
          dayOfWeek:
            description: Day of the week when the scheduled archive starts. The week
              starts with Monday (`1`) and ends with Sunday (`7`).
            format: int32
            maximum: 7
            minimum: 1
            type: integer
          endHour:
            description: Hour of the day when the scheduled window to run one online
              archive ends. This field uses the UTC time zone. The window must have
              a duration of at least two hours. If the end time is before or equal
              to the start time, the window extends to the next day.
            format: int32
            maximum: 23
            minimum: 0
            type: integer
          endMinute:
            description: Minute of the hour when the scheduled window to run one online
              archive ends. This field uses the UTC time zone. The window must have
              a duration of at least two hours. If the end time is before or equal
              to the start time, the window extends to the next day.
            format: int32
            maximum: 59
            minimum: 0
            type: integer
          startHour:
            description: Hour of the day when the scheduled window to run one online
              archive starts. This field uses the UTC time zone.
            format: int32
            maximum: 23
            minimum: 0
            type: integer
          startMinute:
            description: Minute of the hour when the scheduled window to run one online
              archive starts. This field uses the UTC time zone.
            format: int32
            maximum: 59
            minimum: 0
            type: integer
        type: object
      required:
      - type
      type: object
    X509Certificate:
      properties:
        notAfter:
          description: Latest date that the certificate is valid. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        notBefore:
          description: Earliest date that the certificate is valid. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
      type: object
    X509CertificateUpdate:
      properties:
        content:
          description: Certificate content.
          type: string
        notAfter:
          description: Latest date that the certificate is valid. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
        notBefore:
          description: Earliest date that the certificate is valid. This parameter
            expresses its value in the ISO 8601 timestamp format in UTC.
          format: date-time
          type: string
      type: object
    ZoneMapping:
      description: Human-readable label that identifies the subset of a global cluster.
      properties:
        location:
          description: Code that represents a location that maps to a zone in your
            global cluster. MongoDB Cloud represents this location with a ISO 3166-2
            location and subdivision codes when possible.
          type: string
        zone:
          description: Human-readable label that identifies the zone in your global
            cluster. This zone maps to a location code.
          type: string
      required:
      - location
      - zone
      title: Global Cluster Zone
      type: object
    charFilterhtmlStrip:
      description: Filter that strips out HTML constructs.
      properties:
        ignoredTags:
          description: The HTML tags that you want to exclude from filtering.
          items:
            type: string
          type: array
        type:
          description: Human-readable label that identifies this character filter
            type.
          enum:
          - htmlStrip
          type: string
      required:
      - type
      title: htmlStrip
      type: object
    charFiltericuNormalize:
      description: Filter that processes normalized text with the ICU Normalizer.
        It is based on Lucene's ICUNormalizer2CharFilter.
      externalDocs:
        description: ICUNormalizer2CharFilter
        url: https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html
      properties:
        type:
          description: Human-readable label that identifies this character filter
            type.
          enum:
          - icuNormalize
          type: string
      required:
      - type
      title: icuNormalize
      type: object
    charFiltermapping:
      description: Filter that applies normalization mappings that you specify to
        characters.
      properties:
        mappings:
          additionalProperties:
            type: string
          description: |-
            Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:

            `<original> : <replacement>`.
          type: object
        type:
          description: Human-readable label that identifies this character filter
            type.
          enum:
          - mapping
          type: string
      required:
      - mappings
      - type
      title: mapping
      type: object
    charFilterpersian:
      description: Filter that replaces instances of a zero-width non-joiner with
        an ordinary space. It is based on Lucene's PersianCharFilter.
      externalDocs:
        description: PersianCharFilter
        url: https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html
      properties:
        type:
          description: Human-readable label that identifies this character filter
            type.
          enum:
          - persian
          type: string
      required:
      - type
      title: persian
      type: object
    raw:
      description: Additional meta information captured about this event. The response
        returns this parameter as a JSON object when the query parameter `includeRaw=true`.
        The list of fields in the raw document may change. Don't rely on raw values
        for formal monitoring.
      properties:
        _t:
          description: Unique identifier of event type.
          example: ALERT_AUDIT
          type: string
        alertConfigId:
          description: Unique 24-hexadecimal digit string that identifies the alert
            configuration related to the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        cid:
          description: Unique 24-hexadecimal digit string that identifies the project
            in which the event occurred.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        cre:
          description: Date and time when this event occurred. This parameter expresses
            its value in the ISO 8601 timestamp format in UTC.
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          readOnly: true
          type: string
        description:
          description: Description of the event.
          example: Alert Acknowledged
          type: string
        gn:
          description: Human-readable label that identifies the project.
          example: Test Project
          maxLength: 64
          minLength: 1
          type: string
        id:
          description: Unique 24-hexadecimal digit string that identifies the event.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        orgId:
          description: Unique 24-hexadecimal digit string that identifies the organization
            to which these events apply.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
        orgName:
          description: Human-readable label that identifies the organization that
            contains the project.
          example: Test Organization
          maxLength: 64
          minLength: 1
          type: string
        severity:
          description: Severity of the event.
          enum:
          - INFO
          - WARNING
          - ERROR
          - CRITICAL
          type: string
      readOnly: true
      type: object
    tokenFilterasciiFolding:
      description: Filter that converts alphabetic, numeric, and symbolic Unicode
        characters that are not in the Basic Latin Unicode block to their ASCII equivalents,
        if available.
      externalDocs:
        description: Basic Latin Unicode block
        url: https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
      properties:
        originalTokens:
          default: omit
          description: |-
            Value that indicates whether to include or omit the original tokens in the output of the token filter.

            Choose `include` if you want to support queries on both the original tokens as well as the converted forms.

             Choose `omit` if you want to query only on the converted forms of the original tokens.
          enum:
          - omit
          - include
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - asciiFolding
          type: string
      required:
      - type
      title: asciiFolding
      type: object
    tokenFilterdaitchMokotoffSoundex:
      description: |-
        Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.

        **NOTE**: Don't use the `daitchMokotoffSoundex` token filter in:

        -Synonym or autocomplete mapping definitions
        - Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.
      externalDocs:
        description: Daitch-Mokotoff Soundex phonetic algorithm
        url: https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex
      properties:
        originalTokens:
          default: include
          description: |-
            Value that indicates whether to include or omit the original tokens in the output of the token filter.

            Choose `include` if you want to support queries on both the original tokens as well as the converted forms.

             Choose `omit` if you want to query only on the converted forms of the original tokens.
          enum:
          - omit
          - include
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - daitchMokotoffSoundex
          type: string
      required:
      - type
      title: daitchMokotoffSoundex
      type: object
    tokenFilteredgeGram:
      description: Filter that tokenizes input from the left side, or "edge", of a
        text input into n-grams of configured sizes. You can't use this token filter
        in synonym or autocomplete mapping definitions.
      properties:
        maxGram:
          description: Value that specifies the maximum length of generated n-grams.
            This value must be greater than or equal to `minGram`.
          type: integer
        minGram:
          description: Value that specifies the minimum length of generated n-grams.
            This value must be less than or equal to `maxGram`.
          type: integer
        termNotInBounds:
          default: omit
          description: Value that indicates whether to index tokens shorter than `minGram`
            or longer than `maxGram`.
          enum:
          - omit
          - include
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - edgeGram
          type: string
      required:
      - maxGram
      - minGram
      - type
      title: edgeGram
      type: object
    tokenFiltericuFolding:
      description: 'Filter that applies character folding from Unicode Technical Report
        #30.'
      externalDocs:
        description: 'Unicode Technical Report #30'
        url: http://www.unicode.org/reports/tr30/tr30-4.html
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - icuFolding
          type: string
      required:
      - type
      title: icuFolding
      type: object
    tokenFiltericuNormalizer:
      description: Filter that normalizes tokens using a standard Unicode Normalization
        Mode.
      externalDocs:
        description: Unicode Normalization Mode
        url: https://unicode.org/reports/tr15/
      properties:
        normalizationForm:
          default: nfc
          description: Normalization form to apply.
          enum:
          - nfd
          - nfc
          - nfkd
          - nfkc
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - icuNormalizer
          type: string
      required:
      - type
      title: icuNormalizer
      type: object
    tokenFilterlength:
      description: Filter that removes tokens that are too short or too long.
      properties:
        max:
          default: 255
          description: Number that specifies the maximum length of a token. Value
            must be greater than or equal to **min**.
          type: integer
        min:
          default: 0
          description: Number that specifies the minimum length of a token. This value
            must be less than or equal to **max**.
          type: integer
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - length
          type: string
      required:
      - type
      title: length
      type: object
    tokenFilterlowercase:
      description: Filter that normalizes token text to lowercase.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - lowercase
          type: string
      required:
      - type
      title: lowercase
      type: object
    tokenFilternGram:
      description: Filter that tokenizes input into n-grams of configured sizes. You
        can't use this token filter in synonym or autocomplete mapping definitions.
      properties:
        maxGram:
          description: Value that specifies the maximum length of generated n-grams.
            This value must be greater than or equal to `minGram`.
          type: integer
        minGram:
          description: Value that specifies the minimum length of generated n-grams.
            This value must be less than or equal to `maxGram`.
          type: integer
        termNotInBounds:
          default: omit
          description: Value that indicates whether to index tokens shorter than `minGram`
            or longer than `maxGram`.
          enum:
          - omit
          - include
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - nGram
          type: string
      required:
      - maxGram
      - minGram
      - type
      title: nGram
      type: object
    tokenFilterregex:
      description: Filter that applies a regular expression to each token, replacing
        matches with a specified string.
      properties:
        matches:
          description: Value that indicates whether to replace only the first matching
            pattern or all matching patterns.
          enum:
          - all
          - first
          type: string
        pattern:
          description: Regular expression pattern to apply to each token.
          type: string
        replacement:
          description: Replacement string to substitute wherever a matching pattern
            occurs.
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - regex
          type: string
      required:
      - matches
      - pattern
      - replacement
      - type
      title: regex
      type: object
    tokenFilterreverse:
      description: Filter that reverses each string token.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - reverse
          type: string
      required:
      - type
      title: reverse
      type: object
    tokenFiltershingle:
      description: Filter that constructs shingles (token n-grams) from a series of
        tokens. You can't use this token filter in synonym or autocomplete mapping
        definitions.
      properties:
        maxShingleSize:
          description: Value that specifies the maximum number of tokens per shingle.
            This value must be greater than or equal to `minShingleSize`.
          type: integer
        minShingleSize:
          description: Value that specifies the minimum number of tokens per shingle.
            This value must be less than or equal to `maxShingleSize`.
          type: integer
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - shingle
          type: string
      required:
      - maxShingleSize
      - minShingleSize
      - type
      title: shingle
      type: object
    tokenFiltersnowballStemming:
      description: Filter that stems tokens using a Snowball-generated stemmer.
      externalDocs:
        description: Snowball-generated stemmer
        url: https://snowballstem.org/
      properties:
        stemmerName:
          description: Snowball-generated stemmer to use.
          enum:
          - arabic
          - armenian
          - basque
          - catalan
          - danish
          - dutch
          - english
          - finnish
          - french
          - german
          - german2
          - hungarian
          - irish
          - italian
          - kp
          - lithuanian
          - lovins
          - norwegian
          - porter
          - portuguese
          - romanian
          - russian
          - spanish
          - swedish
          - turkish
          type: string
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - snowballStemming
          type: string
      required:
      - stemmerName
      - type
      title: snowballStemming
      type: object
    tokenFilterstopword:
      description: Filter that removes tokens that correspond to the specified stop
        words. This token filter doesn't analyze the stop words that you specify.
      properties:
        ignoreCase:
          default: true
          description: Flag that indicates whether to ignore the case of stop words
            when filtering the tokens to remove.
          type: boolean
        tokens:
          description: The stop words that correspond to the tokens to remove. Value
            must be one or more stop words.
          items:
            type: string
          type: array
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - stopword
          type: string
      required:
      - tokens
      - type
      title: stopword
      type: object
    tokenFiltertrim:
      description: Filter that trims leading and trailing whitespace from tokens.
      properties:
        type:
          description: Human-readable label that identifies this token filter type.
          enum:
          - trim
          type: string
      required:
      - type
      title: trim
      type: object
    tokenizeredgeGram:
      description: Tokenizer that splits input from the left side, or "edge", of a
        text input into n-grams of given sizes. You can't use the edgeGram tokenizer
        in synonym or autocomplete mapping definitions.
      properties:
        maxGram:
          description: Characters to include in the longest token that Atlas Search
            creates.
          type: integer
        minGram:
          description: Characters to include in the shortest token that Atlas Search
            creates.
          type: integer
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - edgeGram
          type: string
      required:
      - maxGram
      - minGram
      - type
      title: edgeGram
      type: object
    tokenizerkeyword:
      description: Tokenizer that combines the entire input as a single token.
      properties:
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - keyword
          type: string
      required:
      - type
      title: keyword
      type: object
    tokenizernGram:
      description: Tokenizer that splits input into text chunks, or "n-grams", of
        into given sizes. You can't use the nGram tokenizer in synonym or autocomplete
        mapping definitions.
      properties:
        maxGram:
          description: Characters to include in the longest token that Atlas Search
            creates.
          type: integer
        minGram:
          description: Characters to include in the shortest token that Atlas Search
            creates.
          type: integer
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - edgeGram
          type: string
      required:
      - maxGram
      - minGram
      - type
      title: nGram
      type: object
    tokenizerregexCaptureGroup:
      description: Tokenizer that uses a regular expression pattern to extract tokens.
      properties:
        group:
          description: Index of the character group within the matching expression
            to extract into tokens. Use `0` to extract all character groups.
          type: integer
        pattern:
          description: Regular expression to match against.
          type: string
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - regexCaptureGroup
          type: string
      required:
      - group
      - pattern
      - type
      title: regexCaptureGroup
      type: object
    tokenizerregexSplit:
      description: Tokenizer that splits tokens using a regular-expression based delimiter.
      properties:
        pattern:
          description: Regular expression to match against.
          type: string
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - regexSplit
          type: string
      required:
      - pattern
      - type
      title: regexSplit
      type: object
    tokenizerstandard:
      description: Tokenizer that splits tokens based on word break rules from the
        Unicode Text Segmentation algorithm.
      externalDocs:
        description: Unicode Text Segmentation Algorithm
        url: https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf
      properties:
        maxTokenLength:
          default: 255
          description: Maximum number of characters in a single token. Tokens greater
            than this length are split at this length into multiple tokens.
          type: integer
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - standard
          type: string
      required:
      - type
      title: standard
      type: object
    tokenizeruaxUrlEmail:
      description: Tokenizer that creates tokens from URLs and email addresses. Although
        this tokenizer uses word break rules from the Unicode Text Segmentation algorithm,
        we recommend using it only when the indexed field value includes URLs and
        email addresses. For fields that don't include URLs or email addresses, use
        the **standard** tokenizer to create tokens based on word break rules.
      externalDocs:
        description: Unicode Text Segmentation Algorithm
        url: https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf
      properties:
        maxTokenLength:
          default: 255
          description: Maximum number of characters in a single token. Tokens greater
            than this length are split at this length into multiple tokens.
          type: integer
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - uaxUrlEmail
          type: string
      required:
      - type
      title: uaxUrlEmail
      type: object
    tokenizerwhitespace:
      description: Tokenizer that creates tokens based on occurrences of whitespace
        between words.
      properties:
        maxTokenLength:
          default: 255
          description: Maximum number of characters in a single token. Tokens greater
            than this length are split at this length into multiple tokens.
          type: integer
        type:
          description: Human-readable label that identifies this tokenizer type.
          enum:
          - whitespace
          type: string
      required:
      - type
      title: whitespace
      type: object
  securitySchemes:
    DigestAuth:
      scheme: digest
      type: http
    ServiceAccounts:
      description: Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://cloud.mongodb.com/api/oauth/token
      type: oauth2
info:
  description: |-
    The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.

    The Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the recommended authentication method and API keys are considered a legacy option.

    To authenticate with a Service Account, first exchange its client ID and secret for an access token using the OAuth 2.0 Client Credentials flow. Atlas provides a token endpoint at `POST https://cloud.mongodb.com/api/oauth/token`, which returns a Bearer token that is reusable and valid for 1 hour (3600 seconds).

    For example, to [return a list of your organizations](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs) with [cURL](https://en.wikipedia.org/wiki/CURL), first generate an access token and then use that token to call the same Atlas Administration API endpoint shown in the current example:

    ```
    ACCESS_TOKEN=$(curl -fsS --request POST https://cloud.mongodb.com/api/oauth/token \
      --header "Authorization: Basic $(printf '%s' "${CLIENT_ID}:${CLIENT_SECRET}" | base64 | tr -d '\n')" \
      --header "Content-Type: application/x-www-form-urlencoded" \
      --header "Accept: application/json" \
      --data "grant_type=client_credentials" | jq -r '.access_token')

    curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
      --header "Accept: application/vnd.atlas.2025-03-12+json" \
      -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true"
    ```

    If your organization requires an IP access list for the Atlas Administration API, the token can be created from any IP address, but the API call that uses the token must originate from an allowed IP.

    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).

    You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/) (requires a Postman account).
  license:
    name: CC BY-NC-SA 3.0 US
    url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/
  termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
  title: MongoDB Atlas Administration API
  version: '2.0'
  x-xgen-sha: 3d70e065843c008b9871ea7836c98c9de6f202f9
openapi: 3.0.1
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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          description: Unauthorized.
        '403':
          "$ref": "#/components/responses/forbidden"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return the Status of This MongoDB Application
      tags:
      - Root
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api root getSystemStatus --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetSystemStatusApiParams{}\n\tsdkResp,
          httpResp, err := client.RootApi.\n\t\tGetSystemStatusWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus
      x-xgen-method-verb-override:
        customMethod: false
        verb: getSystemStatus
  "/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: listAlertConfigMatcherFieldNames
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/MatcherFieldView"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Alert Configuration Matchers Field Names
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations listMatcherFieldNames --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListAlertConfigMatcherFieldNamesApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tListAlertConfigMatcherFieldNamesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigMatcherFieldNames
      x-xgen-operation-id-override: listMatcherFieldNames
  "/api/atlas/v2/clusters":
    get:
      description: Returns the details for all clusters in all projects to which you
        have access. Clusters contain a group of hosts that maintain the same data
        set. The response does not include multi-cloud clusters. To use this resource,
        the requesting Service Account or API Key can have any cluster-level role.
      operationId: listClusterDetails
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedOrgGroupView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Authorized Clusters in All Projects
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters listClusterDetails --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListClusterDetailsApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tListClusterDetailsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusterDetails
      x-xgen-method-verb-override:
        customMethod: false
        verb: listDetails
  "/api/atlas/v2/eventTypes":
    get:
      description: Returns a list of all event types, along with a description and
        additional metadata about each event.
      operationId: listEventTypes
      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/PaginatedEventTypeDetailsResponse"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Event Types
      tags:
      - Events
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api events listEventTypes --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListEventTypesApiParams{}\n\tsdkResp,
          httpResp, err := client.EventsApi.\n\t\tListEventTypesWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true"
      x-rolesRequirements:
      - Organization Member
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes
  "/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
        Service Account or 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: deleteFederationSetting
      parameters:
      - "$ref": "#/components/parameters/federationSettingsId"
      responses:
        '204':
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: '2023-01-01'
          description: No Content
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Federation Settings Instance
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication deleteFederationSetting --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteFederationSettingApiParams{}\n\thttpResp,
          err := client.FederatedAuthenticationApi.\n\t\tDeleteFederationSettingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSetting
  "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs":
    get:
      description: Returns all connected organization configurations in the specified
        federation. To use this resource, the requesting Service Account or API Key
        must have the Organization Owner role in one of the connected organizations.
      operationId: listFederationSettingConnectedOrgConfigs
      parameters:
      - "$ref": "#/components/parameters/federationSettingsId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedConnectedOrgConfigsView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Organization Configurations from One Federation
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication listConnectedOrgConfigs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListFederationSettingConnectedOrgConfigsApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tListFederationSettingConnectedOrgConfigsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingConnectedOrgConfigs
      x-xgen-operation-id-override: listConnectedOrgConfigs
  "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}":
    delete:
      description: 'Removes one connected organization configuration from the specified
        federation. To use this resource, the requesting Service Account or API Key
        must have the Organization Owner role. Note: This request fails if only one
        connected organization exists in the federation.'
      operationId: removeFederationSettingConnectedOrgConfig
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Organization Configuration from One Federation
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication removeConnectedOrgConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveFederationSettingConnectedOrgConfigApiParams{}\n\thttpResp,
          err := client.FederatedAuthenticationApi.\n\t\tRemoveFederationSettingConnectedOrgConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeFederationSettingConnectedOrgConfig
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: remove
      x-xgen-operation-id-override: removeConnectedOrgConfig
    get:
      description: Returns the specified connected organization configuration from
        the specified federation. To use this resource, the requesting Service Account
        or API Key must have the Organization Owner role in the connected organization.
      operationId: getFederationSettingConnectedOrgConfig
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ConnectedOrgConfig"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Organization Configuration from One Federation
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication getConnectedOrgConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetFederationSettingConnectedOrgConfigApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tGetFederationSettingConnectedOrgConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingConnectedOrgConfig
      x-xgen-operation-id-override: getConnectedOrgConfig
    patch:
      description: "Updates one connected organization configuration from the specified
        federation. To use this resource, the requesting Service Account or 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: updateFederationSettingConnectedOrgConfig
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Organization Configuration in One Federation
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication updateConnectedOrgConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateFederationSettingConnectedOrgConfigApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tUpdateFederationSettingConnectedOrgConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingConnectedOrgConfig
      x-xgen-operation-id-override: updateConnectedOrgConfig
  "/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 Service Account
        or API Key must have the Organization Owner role.
      operationId: listFederationSettingConnectedOrgConfigRoleMappings
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Role Mappings from One Organization
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication listRoleMappings --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListFederationSettingConnectedOrgConfigRoleMappingsApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tListFederationSettingConnectedOrgConfigRoleMappingsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingConnectedOrgConfigRoleMappings
      x-xgen-operation-id-override: listRoleMappings
    post:
      description: Adds one role mapping to the specified organization in the specified
        federation. To use this resource, the requesting Service Account or API Key
        must have the Organization Owner role.
      operationId: createFederationSettingConnectedOrgConfigRoleMapping
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Role Mapping in One Organization Configuration
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication createRoleMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateFederationSettingConnectedOrgConfigRoleMappingApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tCreateFederationSettingConnectedOrgConfigRoleMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createFederationSettingConnectedOrgConfigRoleMapping
      x-xgen-operation-id-override: createRoleMapping
  "/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 Service Account
        or API Key must have the Organization Owner role.
      operationId: deleteFederationSettingConnectedOrgConfigRoleMapping
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Role Mapping from One Organization
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication deleteRoleMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteFederationSettingConnectedOrgConfigRoleMappingApiParams{}\n\thttpResp,
          err := client.FederatedAuthenticationApi.\n\t\tDeleteFederationSettingConnectedOrgConfigRoleMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSettingConnectedOrgConfigRoleMapping
      x-xgen-operation-id-override: deleteRoleMapping
    get:
      description: Returns one role mapping from the specified organization in the
        specified federation. To use this resource, the requesting Service Account
        or API Key must have the Organization Owner role.
      operationId: getFederationSettingConnectedOrgConfigRoleMapping
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Role Mapping from One Organization
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication getRoleMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetFederationSettingConnectedOrgConfigRoleMappingApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tGetFederationSettingConnectedOrgConfigRoleMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingConnectedOrgConfigRoleMapping
      x-xgen-operation-id-override: getRoleMapping
    put:
      description: Updates one role mapping in the specified organization in the specified
        federation. To use this resource, the requesting Service Account or API Key
        must have the Organization Owner role.
      operationId: updateFederationSettingConnectedOrgConfigRoleMapping
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Role Mapping in One Organization
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication updateRoleMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateFederationSettingConnectedOrgConfigRoleMappingApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tUpdateFederationSettingConnectedOrgConfigRoleMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingConnectedOrgConfigRoleMapping
      x-xgen-operation-id-override: updateRoleMapping
  "/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 Service Account
        or API Key must have the Organization Owner role in one of the connected organizations.
      operationId: listFederationSettingIdentityProviders
      parameters:
      - "$ref": "#/components/parameters/federationSettingsId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - description: The protocols of the target identity providers.
        in: query
        name: protocol
        schema:
          items:
            default: SAML
            enum:
            - SAML
            - OIDC
            type: string
          type: array
      - description: The types of the target identity providers.
        in: query
        name: idpType
        schema:
          items:
            default: WORKFORCE
            enum:
            - WORKFORCE
            - WORKLOAD
            type: string
          type: array
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedFederationIdentityProvider"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Identity Providers in One Federation
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication listIdentityProviders --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListFederationSettingIdentityProvidersApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tListFederationSettingIdentityProvidersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listFederationSettingIdentityProviders
      x-xgen-operation-id-override: listIdentityProviders
    post:
      description: |-
        Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or 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: createFederationSettingIdentityProvider
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Identity Provider
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication createIdentityProvider --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateFederationSettingIdentityProviderApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tCreateFederationSettingIdentityProviderWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createFederationSettingIdentityProvider
      x-xgen-operation-id-override: createIdentityProvider
  "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}":
    delete:
      description: "Deletes one identity provider in the specified federation. To
        use this resource, the requesting Service Account or API Key must have the
        Organization Owner role for the connected organization. \n\n**Note**: Requests
        to this resource will fail if the identity provider is connected to more than
        one organization or is connected to an organization unowned by the requesting
        Service Account or API key. Before deleting an identity provider, confirm
        that no organization in your federation uses this identity provider."
      externalDocs:
        description: Manage Organization Mapping for Federated Authentication
        url: https://www.mongodb.com/docs/atlas/security/manage-org-mapping/
      operationId: deleteFederationSettingIdentityProvider
      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:
          example: 32b6e34b3d91647abb20e7b8
          type: string
      - "$ref": "#/components/parameters/envelope"
      responses:
        '204':
          content:
            application/vnd.atlas.2023-11-15+json:
              x-xgen-version: '2023-11-15'
          description: No Response
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Identity Provider
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication deleteIdentityProvider --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteFederationSettingIdentityProviderApiParams{}\n\thttpResp,
          err := client.FederatedAuthenticationApi.\n\t\tDeleteFederationSettingIdentityProviderWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationSettingIdentityProvider
      x-xgen-operation-id-override: deleteIdentityProvider
    get:
      description: 'Returns one identity provider in the specified federation by the
        identity provider''s id. To use this resource, the requesting Service Account
        or API Key must have the Organization Owner role in one of the connected organizations.
        Deprecated versions: v2-{2023-01-01}'
      operationId: getFederationSettingIdentityProvider
      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:
          example: 32b6e34b3d91647abb20e7b8
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Identity Provider by ID
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication getIdentityProvider --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetFederationSettingIdentityProviderApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tGetFederationSettingIdentityProviderWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingIdentityProvider
      x-xgen-operation-id-override: getIdentityProvider
    patch:
      description: |-
        Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or 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.

        **Note**: When deactivating a SAML identity provider connected to an organization, the requesting Service Account or API key must have the Organization Owner role for the organization. If the identity provider is connected to multiple organizations, the request will fail. Deprecated versions: v2-{2023-01-01}
      operationId: updateFederationSettingIdentityProvider
      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:
          example: 32b6e34b3d91647abb20e7b8
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '405':
          "$ref": "#/components/responses/methodNotAllowed"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Identity Provider
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication updateIdentityProvider --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateFederationSettingIdentityProviderApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tUpdateFederationSettingIdentityProviderWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateFederationSettingIdentityProvider
      x-xgen-operation-id-override: updateIdentityProvider
  "/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 Service Account or 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."
      externalDocs:
        description: Configure OIDC Authorization
        url: https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks
      operationId: revokeFederationSettingIdentityProviderJwks
      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:
          example: 32b6e34b3d91647abb20e7b8
          type: string
      - "$ref": "#/components/parameters/envelope"
      responses:
        '204':
          content:
            application/vnd.atlas.2023-11-15+json:
              x-xgen-version: '2023-11-15'
          description: No Response
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Revoke JWKS from One OIDC Identity Provider
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication revokeIdentityProviderJwks --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RevokeFederationSettingIdentityProviderJwksApiParams{}\n\thttpResp,
          err := client.FederatedAuthenticationApi.\n\t\tRevokeFederationSettingIdentityProviderJwksWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeFederationSettingIdentityProviderJwks
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: revoke
      x-xgen-operation-id-override: revokeIdentityProviderJwks
  "/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 Service Account or API Key
        must have the Organization Owner role in one of the connected organizations.
      operationId: getFederationSettingIdentityProviderMetadata
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '405':
          "$ref": "#/components/responses/methodNotAllowed"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Metadata of One Identity Provider
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication getIdentityProviderMetadata --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetFederationSettingIdentityProviderMetadataApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tGetFederationSettingIdentityProviderMetadataWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettingIdentityProviderMetadata
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getIdentityProviderMetadata
  "/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 Service Account or API Key
        must have the Organization Read Only role or higher.
      operationId: listGroups
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Projects
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects listGroups --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupsApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tListGroupsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroups
    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 Service Account or API Key must have the Read Write
        role.
      operationId: createGroup
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects createGroup --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tCreateGroupWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
            -d '{ <Payload> }'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createGroup
  "/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 Service Account or API Key
        must have the Project Read Only role.
      operationId: getGroupByName
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies this project.
        in: path
        name: groupName
        required: true
        schema:
          maxLength: 64
          minLength: 1
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/Group"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Project by Name
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getGroupByName --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupByNameApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupByNameWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupByName
  "/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 Service Account or API
        Key must have the Project Owner role.
      operationId: deleteGroup
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects deleteGroup --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupApiParams{}\n\thttpResp,
          err := client.ProjectsApi.\n\t\tDeleteGroupWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroup
    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 Service Account or API Key
        must have the Project Read Only role.
      operationId: getGroup
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getGroup --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroup
    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 Service Account or API Key must have the Project Owner role.
      operationId: updateGroup
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects updateGroup --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tUpdateGroupWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroup
  "/api/atlas/v2/groups/{groupId}/access":
    post:
      deprecated: true
      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
        Service Account or API Key must have the Group User Admin role.
      operationId: addGroupAccessUser
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '204':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: No Content
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One MongoDB Cloud User to One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects addGroupUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddGroupAccessUserApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tAddGroupAccessUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addGroupAccessUser
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: addUser
      x-xgen-operation-id-override: addGroupUser
  "/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 Service Account or 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: listGroupAccessListEntries
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Project IP Access List Entries
      tags:
      - Project IP Access List
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projectIpAccessList listAccessListEntries --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupAccessListEntriesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectIPAccessListApi.\n\t\tListGroupAccessListEntriesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-changelog:
        '2025-05-08': Corrects an issue where the endpoint would include Atlas internal
          entries.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listGroupAccessListEntries
      x-xgen-method-verb-override:
        customMethod: false
        verb: listEntries
      x-xgen-operation-id-override: listAccessListEntries
    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
        Service Account or API Key must have the Project Owner role, Project Charts
        Admin role, or Project Network Access Manager 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. 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: createGroupAccessListEntry
      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:
              items:
                "$ref": "#/components/schemas/NetworkPermissionEntry"
              type: array
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add Entries to Project IP Access List
      tags:
      - Project IP Access List
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projectIpAccessList createAccessListEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupAccessListEntryApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectIPAccessListApi.\n\t\tCreateGroupAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Network Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createGroupAccessListEntry
      x-xgen-method-verb-override:
        customMethod: false
        verb: createEntry
      x-xgen-operation-id-override: createAccessListEntry
  "/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 Service Account or API
        Key must have the Project Owner role or Project Network Access Manager 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: deleteGroupAccessListEntry
      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:
          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})?$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Entry from One Project IP Access List
      tags:
      - Project IP Access List
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projectIpAccessList deleteAccessListEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupAccessListEntryApiParams{}\n\thttpResp,
          err := client.ProjectIPAccessListApi.\n\t\tDeleteGroupAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}"
      x-rolesRequirements:
      - Project Network Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteGroupAccessListEntry
      x-xgen-method-verb-override:
        customMethod: false
        verb: deleteEntry
      x-xgen-operation-id-override: deleteAccessListEntry
    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 Service Account or 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. The Programmatic 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: getGroupAccessListEntry
      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:
          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})?$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/NetworkPermissionEntry"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Project IP Access List Entry
      tags:
      - Project IP Access List
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projectIpAccessList getAccessListEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAccessListEntryApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectIPAccessListApi.\n\t\tGetGroupAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getGroupAccessListEntry
      x-xgen-method-verb-override:
        customMethod: false
        verb: getEntry
      x-xgen-operation-id-override: getAccessListEntry
  "/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: getGroupAccessListStatus
      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:
          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})?$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/NetworkPermissionEntryStatus"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Status of One Project IP Access List Entry
      tags:
      - Project IP Access List
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projectIpAccessList getAccessListStatus --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAccessListStatusApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectIPAccessListApi.\n\t\tGetGroupAccessListStatusWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getGroupAccessListStatus
      x-xgen-operation-id-override: getAccessListStatus
  "/api/atlas/v2/groups/{groupId}/activityFeed":
    get:
      description: Returns a pre-filtered activity feed link for the specified project
        based on the provided date range and event types. The returned link can be
        shared and opened to view the activity feed with the same filters applied.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role or higher.
      operationId: getGroupActivityFeed
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$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:
          description: List of event types to filter the activity feed.
          externalDocs:
            description: Event Types
            url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
          items:
            "$ref": "#/components/schemas/EventTypeForNdsGroup"
          maxItems: 20
          type: array
      - description: End date and time for events to include in the activity feed
          link. ISO 8601 timestamp format in UTC.
        in: query
        name: maxDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      - description: Start date and time for events to include in the activity feed
          link. ISO 8601 timestamp format in UTC.
        in: query
        name: minDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      - description: Human-readable label that identifies the cluster.
        in: query
        name: clusterName
        schema:
          description: List of cluster names to filter the activity feed.
          items:
            type: string
          maxItems: 20
          type: array
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/ActivityFeedLinkResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Pre-Filtered Activity Feed Link for One Project
      tags:
      - Activity Feed
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api activityFeed getGroupActivityFeed --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupActivityFeedApiParams{}\n\tsdkResp,
          httpResp, err := client.ActivityFeedApi.\n\t\tGetGroupActivityFeedWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/activityFeed?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/activityFeed?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Activity-Feed/operation/getGroupActivityFeed
  "/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 Service Account or API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listGroupAlertConfigs
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Alert Configurations in One Project
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations listAlertConfigs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupAlertConfigsApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tListGroupAlertConfigsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listGroupAlertConfigs
      x-xgen-operation-id-override: listAlertConfigs
    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 Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role.

        This resource remains under revision and may change.
      operationId: createGroupAlertConfig
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Alert Configuration in One Project
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations createAlertConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupAlertConfigApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tCreateGroupAlertConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Alerts Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createGroupAlertConfig
      x-xgen-operation-id-override: createAlertConfig
  "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}":
    delete:
      description: |-
        Removes one alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return All Alert Configurations for One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations
      operationId: deleteGroupAlertConfig
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the alert
          configuration.
        in: path
        name: alertConfigId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: '2023-01-01'
          description: No Content
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Alert Configuration from One Project
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations deleteAlertConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupAlertConfigApiParams{}\n\thttpResp,
          err := client.AlertConfigurationsApi.\n\t\tDeleteGroupAlertConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}"
      x-rolesRequirements:
      - Project Alerts Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteGroupAlertConfig
      x-xgen-operation-id-override: deleteAlertConfig
    get:
      description: |-
        Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return All Alert Configurations for One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations
      operationId: getGroupAlertConfig
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the alert
          configuration.
        in: path
        name: alertConfigId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/GroupAlertsConfig"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Alert Configuration from One Project
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations getAlertConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAlertConfigApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tGetGroupAlertConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertConfig
      x-xgen-operation-id-override: getAlertConfig
    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 Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, 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.

        This resource remains under revision and may change.
      externalDocs:
        description: Update One Alert Configuration
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration
      operationId: toggleGroupAlertConfig
      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.
        in: path
        name: alertConfigId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Toggle State of One Alert Configuration in One Project
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations toggleAlertConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ToggleGroupAlertConfigApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tToggleGroupAlertConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Alerts Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleGroupAlertConfig
      x-xgen-method-verb-override:
        customMethod: true
        verb: toggle
      x-xgen-operation-id-override: toggleAlertConfig
    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 Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, 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.

        This resource remains under revision and may change.
      externalDocs:
        description: Toggle One State of One Alert Configuration in One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration
      operationId: updateGroupAlertConfig
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the alert
          configuration.
        in: path
        name: alertConfigId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Alert Configuration in One Project
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations updateAlertConfig --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupAlertConfigApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tUpdateGroupAlertConfigWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Alerts Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateGroupAlertConfig
      x-xgen-operation-id-override: updateAlertConfig
  "/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 Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return All Alert Configurations for One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations
      operationId: getGroupAlertConfigAlerts
      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.
        in: path
        name: alertConfigId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedAlertView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Open Alerts for One Alert Configuration
      tags:
      - Alerts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alerts getAlertConfigAlerts --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAlertConfigAlertsApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertsApi.\n\t\tGetGroupAlertConfigAlertsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getGroupAlertConfigAlerts
      x-xgen-operation-id-override: getAlertConfigAlerts
  "/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 Service Account or API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listGroupAlerts
      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 this parameter to return
          all alerts in all statuses. TRACKING indicates the alert condition exists
          but has not persisted for the minimum notification delay. OPEN indicates
          the alert condition currently exists. CLOSED indicates the alert condition
          has been resolved.
        in: query
        name: status
        schema:
          enum:
          - OPEN
          - TRACKING
          - CLOSED
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedAlertView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Alerts from One Project
      tags:
      - Alerts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alerts listAlerts --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupAlertsApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertsApi.\n\t\tListGroupAlertsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listGroupAlerts
      x-xgen-operation-id-override: listAlerts
  "/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 Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return All Alerts from One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts
      operationId: getGroupAlert
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the alert.
        in: path
        name: alertId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/AlertViewForNdsGroup"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Alert from One Project
      tags:
      - Alerts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alerts getAlert --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAlertApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertsApi.\n\t\tGetGroupAlertWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getGroupAlert
      x-xgen-operation-id-override: getAlert
    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 Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.

        This resource remains under revision and may change. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: Return All Alerts from One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts
      operationId: acknowledgeGroupAlert
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the alert.
        in: path
        name: alertId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/AcknowledgeAlert"
        description: Acknowledges or unacknowledges one alert.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/AlertViewForNdsGroup"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Acknowledge One Alert from One Project
      tags:
      - Alerts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alerts acknowledgeAlert --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AcknowledgeGroupAlertApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertsApi.\n\t\tAcknowledgeGroupAlertWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Alerts Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeGroupAlert
      x-xgen-method-verb-override:
        customMethod: true
        verb: acknowledge
      x-xgen-operation-id-override: acknowledgeAlert
  "/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 Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return All Alerts from One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts
      operationId: getGroupAlertAlertConfigs
      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.
        in: path
        name: alertId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedAlertConfigView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Alert Configurations Set for One Alert
      tags:
      - Alert Configurations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api alertConfigurations getAlertConfigs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAlertAlertConfigsApiParams{}\n\tsdkResp,
          httpResp, err := client.AlertConfigurationsApi.\n\t\tGetGroupAlertAlertConfigsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertAlertConfigs
      x-xgen-operation-id-override: getAlertConfigs
  "/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 Service Account or 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: listGroupApiKeys
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Organization API Keys Assigned to One Project
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys listGroupApiKeys --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupApiKeysApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tListGroupApiKeysWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listGroupApiKeys
    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 Service Account or API Key must have the Project
        Owner role or Project Access Manager role.
      operationId: createGroupApiKey
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create and Assign One Organization API Key to One Project
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys createGroupApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupApiKeyApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tCreateGroupApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createGroupApiKey
  "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}":
    delete:
      description: Removes one organization API key from the specified project. To
        use this resource, the requesting Service Account or API Key must have the
        Project Owner role or Project Access Manager role.
      externalDocs:
        description: Programmatic API Keys
        url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key
      operationId: removeGroupApiKey
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Unassign One Organization API Key from One Project
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys removeGroupApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveGroupApiKeyApiParams{}\n\thttpResp,
          err := client.ProgrammaticAPIKeysApi.\n\t\tRemoveGroupApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}"
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeGroupApiKey
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: remove
    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. To use this resource, the requesting Service
        Account or API Key must have the Project Owner role or Project Access Manager
        role.
      operationId: updateGroupApiKeyRoles
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Organization API Key Roles for One Project
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys updateApiKeyRoles --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupApiKeyRolesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tUpdateGroupApiKeyRolesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateGroupApiKeyRoles
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: updateRoles
      x-xgen-operation-id-override: updateApiKeyRoles
    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 Service Account or API Key must have the Project
        Owner role.
      operationId: addGroupApiKey
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              description: Explanatory text that describes this API key, the list
                of roles to grant this API key, or both.
              items:
                "$ref": "#/components/schemas/UserAccessRoleAssignment"
              type: array
        description: Organization API key to be assigned to the specified project.
        required: true
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Assign One Organization API Key to One Project
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys addGroupApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddGroupApiKeyApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tAddGroupApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addGroupApiKey
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: add
  "/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 Service Account or API Key
        must have the Project Owner role. This feature isn't available for `M0`, `M2`,
        `M5`, or serverless clusters.
      operationId: getGroupAuditLog
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Auditing Configuration for One Project
      tags:
      - Auditing
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api auditing getGroupAuditLog --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAuditLogApiParams{}\n\tsdkResp,
          httpResp, err := client.AuditingApi.\n\t\tGetGroupAuditLogWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getGroupAuditLog
    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 Service Account or API Key
        must have the Project Owner role. This feature isn't available for `M0`, `M2`,
        `M5`, or serverless clusters.
      operationId: updateGroupAuditLog
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Auditing Configuration for One Project
      tags:
      - Auditing
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api auditing updateAuditLog --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupAuditLogApiParams{}\n\tsdkResp,
          httpResp, err := client.AuditingApi.\n\t\tUpdateGroupAuditLogWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateGroupAuditLog
      x-xgen-operation-id-override: updateAuditLog
  "/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 Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupAwsCustomDns
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Custom DNS Configuration for Atlas Clusters on AWS
      tags:
      - AWS Clusters DNS
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api awsClustersDns getAwsCustomDns --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAwsCustomDnsApiParams{}\n\tsdkResp,
          httpResp, err := client.AWSClustersDNSApi.\n\t\tGetGroupAwsCustomDnsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getGroupAwsCustomDns
      x-xgen-operation-id-override: getAwsCustomDns
    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 Service Account
        or API Key must have the Project Atlas Admin role.
      operationId: toggleGroupAwsCustomDns
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update State of One Custom DNS Configuration for Atlas Clusters on
        AWS
      tags:
      - AWS Clusters DNS
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api awsClustersDns toggleAwsCustomDns --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ToggleGroupAwsCustomDnsApiParams{}\n\tsdkResp,
          httpResp, err := client.AWSClustersDNSApi.\n\t\tToggleGroupAwsCustomDnsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleGroupAwsCustomDns
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: toggle
      x-xgen-operation-id-override: toggleAwsCustomDns
  "/api/atlas/v2/groups/{groupId}/backup/exportBuckets":
    get:
      description: 'Returns all Export Buckets associated with the specified Project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role. Deprecated versions: v2-{2023-01-01}'
      operationId: listGroupBackupExportBuckets
      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.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/PaginatedBackupSnapshotExportBucketsView"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Snapshot Export Buckets
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listExportBuckets --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupBackupExportBucketsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupBackupExportBucketsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupBackupExportBuckets
      x-xgen-operation-id-override: listExportBuckets
    post:
      description: 'Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob
        Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots
        can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure
        Blob Storage Container, or Google Cloud Storage Bucket. To use this resource,
        the requesting Service Account or API Key must have the Project Owner role.
        Deprecated versions: v2-{2023-01-01}'
      operationId: createGroupBackupExportBucket
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            examples:
              AWS:
                description: AWS
                value:
                  bucketName: export-bucket
                  cloudProvider: AWS
                  iamRoleId: 668c5f0ed436263134491592
                  requirePrivateNetworking: false
              Azure:
                description: Azure
                value:
                  bucketName: examplecontainer
                  cloudProvider: AZURE
                  roleId: 668c5f0ed436263134491592
                  serviceUrl: https://examplestorageaccount.blob.core.windows.net/examplecontainer
              GCP:
                description: GCP
                value:
                  bucketName: export-bucket
                  cloudProvider: GCP
                  roleId: 668c5f0ed436263134491592
            schema:
              "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketRequest"
            x-xgen-version: '2024-05-30'
        description: Specifies the role and AWS S3 Bucket, Azure Blob Storage Container,
          or Google Cloud Storage Bucket that the Export Bucket should reference.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              examples:
                AWS:
                  description: AWS
                  value:
                    _id: 32b6e34b3d91647abb20e7b8
                    bucketName: export-bucket
                    cloudProvider: AWS
                    iamRoleId: 668c5f0ed436263134491592
                    links:
                    - href: https://cloud.mongodb.com/api/atlas
                      rel: self
                    region: us-east-1
                    requirePrivateNetworking: true
                Azure:
                  description: Azure
                  value:
                    _id: 32b6e34b3d91647abb20e7b8
                    bucketName: examplecontainer
                    cloudProvider: AZURE
                    links:
                    - href: https://cloud.mongodb.com/api/atlas
                      rel: self
                    roleId: 668c5f0ed436263134491592
                    serviceUrl: https://examplestorageaccount.blob.core.windows.net/examplecontainer
                    tenantId: 4297fc77-1592-4de8-a6d5-a8c32401df87
                GCP:
                  description: GCP
                  value:
                    _id: 32b6e34b3d91647abb20e7b8
                    bucketName: export-bucket
                    cloudProvider: GCP
                    links:
                    - href: https://cloud.mongodb.com/api/atlas
                      rel: self
                    roleId: 668c5f0ed436263134491592
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Snapshot Export Bucket
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups createExportBucket --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupBackupExportBucketApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupBackupExportBucketWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupBackupExportBucket
      x-xgen-operation-id-override: createExportBucket
  "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}":
    delete:
      description: Deletes an Export Bucket. Auto export must be disabled on all clusters
        in this Project exporting to this Export Bucket before revoking access. To
        use this resource, the requesting Service Account or API Key must have the
        Project Backup Manager role.
      operationId: deleteGroupBackupExportBucket
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Unique 24-hexadecimal character string that identifies the Export
          Bucket.
        in: path
        name: exportBucketId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Snapshot Export Bucket
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups deleteExportBucket --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupBackupExportBucketApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tDeleteGroupBackupExportBucketWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupBackupExportBucket
      x-xgen-operation-id-override: deleteExportBucket
    get:
      description: 'Returns one Export Bucket associated with the specified Project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role. Deprecated versions: v2-{2023-01-01}'
      operationId: getGroupBackupExportBucket
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Unique 24-hexadecimal character string that identifies the Export
          Bucket.
        in: path
        name: exportBucketId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              examples:
                AWS:
                  description: AWS
                  value:
                    _id: 32b6e34b3d91647abb20e7b8
                    bucketName: export-bucket
                    cloudProvider: AWS
                    iamRoleId: 668c5f0ed436263134491592
                    links:
                    - href: https://cloud.mongodb.com/api/atlas
                      rel: self
                    region: us-east-1
                    requirePrivateNetworking: true
                Azure:
                  description: Azure
                  value:
                    _id: 32b6e34b3d91647abb20e7b8
                    bucketName: examplecontainer
                    cloudProvider: AZURE
                    links:
                    - href: https://cloud.mongodb.com/api/atlas
                      rel: self
                    roleId: 668c5f0ed436263134491592
                    serviceUrl: https://examplestorageaccount.blob.core.windows.net/examplecontainer
                    tenantId: 4297fc77-1592-4de8-a6d5-a8c32401df87
                GCP:
                  description: GCP
                  value:
                    _id: 32b6e34b3d91647abb20e7b8
                    bucketName: export-bucket
                    cloudProvider: GCP
                    links:
                    - href: https://cloud.mongodb.com/api/atlas
                      rel: self
                    roleId: 668c5f0ed436263134491592
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotExportBucketResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Snapshot Export Bucket
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getExportBucket --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupBackupExportBucketApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupBackupExportBucketWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupExportBucket
      x-xgen-operation-id-override: getExportBucket
    patch:
      description: Updates the private networking settings for one snapshot export
        bucket in the specified project. To use this resource, the requesting Service
        Account or API Key must have the Project Owner role.
      operationId: updateGroupBackupExportBucket
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal character string that identifies the snapshot
          export bucket.
        in: path
        name: exportBucketId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/UpdateRequirePrivateNetworkingRequestView"
            x-xgen-version: '2024-05-30'
        description: Updates the private networking requirement for the snapshot export
          bucket.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Export Bucket Private Networking Settings
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups updateBackupExportBucket --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupBackupExportBucketApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupBackupExportBucketWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupBackupExportBucket
      x-xgen-operation-id-override: updateBackupExportBucket
  "/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints":
    get:
      description: Returns the private endpoints of the specified cloud provider for
        object storage backup operations.
      operationId: listGroupBackupPrivateEndpoints
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - description: Human-readable label that identifies the cloud provider for the
          private endpoints to return.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AWS
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasObjectStoragePrivateEndpointResponseView"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Object Storage Private Endpoints for Cloud Backups for One Cloud
        Provider in One Project
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listBackupPrivateEndpoints --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupBackupPrivateEndpointsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupBackupPrivateEndpointsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupBackupPrivateEndpoints
      x-xgen-operation-id-override: listBackupPrivateEndpoints
    post:
      description: Creates a private endpoint in the specified region for secure,
        private connectivity between Atlas and cloud provider object storage services
        for backup operations.
      operationId: createGroupBackupPrivateEndpoint
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      - description: Human-readable label that identifies the cloud provider for the
          private endpoint to create.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AWS
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-11-13+json:
            schema:
              "$ref": "#/components/schemas/ObjectStoragePrivateEndpointRequest"
        description: Creates a private endpoint in the specified region for object
          storage backup operations.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/ObjectStoragePrivateEndpointResponse"
              x-xgen-version: '2024-11-13'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Object Storage Private Endpoint for Cloud Backups for One
        Cloud Provider in One Project
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups createBackupPrivateEndpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupBackupPrivateEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupBackupPrivateEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupBackupPrivateEndpoint
      x-xgen-operation-id-override: createBackupPrivateEndpoint
  "/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}":
    delete:
      description: Deletes one private endpoint, identified by its ID, for object
        storage backup operations.
      operationId: deleteGroupBackupPrivateEndpoint
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      - description: Human-readable label that identifies the cloud provider of the
          private endpoint to delete.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AWS
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint to delete.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-11-13+json:
              x-xgen-version: '2024-11-13'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Object Storage Private Endpoint for Cloud Backups for One
        Cloud Provider from One Project
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups deleteBackupPrivateEndpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupBackupPrivateEndpointApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tDeleteGroupBackupPrivateEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupBackupPrivateEndpoint
      x-xgen-operation-id-override: deleteBackupPrivateEndpoint
    get:
      description: Returns one private endpoint, identified by its ID, for object
        storage backup operations.
      operationId: getGroupBackupPrivateEndpoint
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      - description: Human-readable label that identifies the cloud provider of the
          private endpoint.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AWS
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/ObjectStoragePrivateEndpointResponse"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Object Storage Private Endpoint for Cloud Backups for One
        Cloud Provider in One Project
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getBackupPrivateEndpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupBackupPrivateEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupBackupPrivateEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupPrivateEndpoint
      x-xgen-operation-id-override: getBackupPrivateEndpoint
  "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy":
    delete:
      description: Disables the Backup Compliance Policy settings with the specified
        project. As a prerequisite, a support ticket needs to be file first, instructions
        in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role.
      operationId: disableGroupBackupCompliancePolicy
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '204':
          content:
            application/vnd.atlas.2024-11-13+json:
              x-xgen-version: '2024-11-13'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Disable Backup Compliance Policy Settings
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups disableCompliancePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DisableGroupBackupCompliancePolicyApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tDisableGroupBackupCompliancePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableGroupBackupCompliancePolicy
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: disable
      x-xgen-operation-id-override: disableCompliancePolicy
    get:
      description: 'Returns the Backup Compliance Policy settings with the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Owner role. Deprecated versions: v2-{2023-01-01}'
      operationId: getGroupBackupCompliancePolicy
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Backup Compliance Policy Settings
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getCompliancePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupBackupCompliancePolicyApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupBackupCompliancePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupCompliancePolicy
      x-xgen-operation-id-override: getCompliancePolicy
    put:
      description: 'Updates the Backup Compliance Policy settings for the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Owner role. Deprecated versions: v2-{2023-01-01}'
      operationId: updateGroupBackupCompliancePolicy
      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:
          default: true
          type: boolean
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Backup Compliance Policy Settings
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups updateCompliancePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupBackupCompliancePolicyApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupBackupCompliancePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupBackupCompliancePolicy
      x-xgen-operation-id-override: updateCompliancePolicy
  "/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 Service Account or API Key must
        have the Project Owner role.
      operationId: listGroupCloudProviderAccess
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Cloud Provider Access Roles
      tags:
      - Cloud Provider Access
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudProviderAccess listCloudProviderAccess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupCloudProviderAccessApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudProviderAccessApi.\n\t\tListGroupCloudProviderAccessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listGroupCloudProviderAccess
      x-xgen-operation-id-override: listCloudProviderAccess
    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 Service Account or API Key must have
        the Project Owner role. For the GCP provider, if the project folder is not
        yet provisioned, Atlas will now create the role asynchronously. An intermediate
        role with status `IN_PROGRESS` will be returned, and the final service account
        will be provisioned. Once the GCP project is set up, subsequent requests will
        create the service account synchronously.
      externalDocs:
        description: Set Up Access to Cloud Providers
        url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/
      operationId: createGroupCloudProviderAccess
      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/CloudProviderAccessRoleRequest"
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudProviderAccess createCloudProviderAccess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupCloudProviderAccessApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudProviderAccessApi.\n\t\tCreateGroupCloudProviderAccessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createGroupCloudProviderAccess
      x-xgen-operation-id-override: createCloudProviderAccess
  "/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 Service Account or API Key must
        have the Project Owner role.
      operationId: deauthorizeGroupCloudProviderAccessRole
      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:
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the role.
        in: path
        name: roleId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: '2023-01-01'
          description: No Content
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Deauthorize One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudProviderAccess deauthorizeProviderAccessRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeauthorizeGroupCloudProviderAccessRoleApiParams{}\n\thttpResp,
          err := client.CloudProviderAccessApi.\n\t\tDeauthorizeGroupCloudProviderAccessRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeGroupCloudProviderAccessRole
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: deauthorizeRole
      x-xgen-operation-id-override: deauthorizeProviderAccessRole
  "/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 Service Account
        or API Key must have the Project Owner role.
      operationId: getGroupCloudProviderAccess
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/CloudProviderAccessRole"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudProviderAccess getCloudProviderAccess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupCloudProviderAccessApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudProviderAccessApi.\n\t\tGetGroupCloudProviderAccessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getGroupCloudProviderAccess
      x-xgen-operation-id-override: getCloudProviderAccess
    patch:
      description: Grants access to the specified project for the specified access
        role. To use this resource, the requesting Service Account or 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. This is not required
        for GCP service account access.
      externalDocs:
        description: Set Up Access to Cloud Providers
        url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/
      operationId: authorizeGroupCloudProviderAccessRole
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate"
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Authorize One Cloud Provider Access Role
      tags:
      - Cloud Provider Access
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudProviderAccess authorizeProviderAccessRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AuthorizeGroupCloudProviderAccessRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudProviderAccessApi.\n\t\tAuthorizeGroupCloudProviderAccessRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeGroupCloudProviderAccessRole
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: authorizeRole
      x-xgen-operation-id-override: authorizeProviderAccessRole
  "/api/atlas/v2/groups/{groupId}/clusters":
    get:
      description: |-
        Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not  available for serverless clusters.

        This endpoint can also be used on Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the List Flex Clusters endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
      externalDocs:
        description: List Flex Clusters
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
      operationId: listGroupClusters
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - description: Flag that indicates whether to return Clusters with retain backups.
        in: query
        name: includeDeletedWithRetainedBackups
        schema:
          default: false
          type: boolean
      - description: Controls how hardware specification fields are returned in the
          response. When set to true, returns the original client-specified values
          and provides separate effective fields showing current operational values.
          When false (default), hardware specification fields show current operational
          values directly. Primarily used for autoscaling compatibility.
        in: header
        name: Use-Effective-Instance-Fields
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedClusterDescription20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Clusters in One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters listClusters --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClustersApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tListGroupClustersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusters
      x-xgen-operation-id-override: listClusters
    post:
      description: |-
        Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Cluster Creator role. This feature is not available for serverless clusters.

        Please note that using an `instanceSize` of M2 or M5 will create a Flex cluster instead. Support for the `instanceSize` of M2 or M5 will be discontinued in January 2026. We recommend using the Create Flex Cluster API for such configurations moving forward. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
      externalDocs:
        description: Create Flex Cluster
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster
      operationId: createGroupCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Controls how hardware specification fields are returned in the
          response after cluster creation. When set to true, returns the original
          client-specified values and provides separate effective fields showing current
          operational values. When false (default), hardware specification fields
          show current operational values directly. Primarily used for autoscaling
          compatibility.
        in: header
        name: Use-Effective-Instance-Fields
        schema:
          default: false
          type: boolean
      - description: Controls how `replicationSpecs` fields are returned in the response.
          When set to `true`, stores the client's view of `replicationSpecs` and returns
          it in `replicationSpecs`, while the actual cluster state (including auto-scaled
          hardware and auto-added shards) is returned in `effectiveReplicationSpecs`.
          When `false` (default), `replicationSpecs` contains the actual cluster state.
        in: header
        name: Use-Effective-Fields-Replication-Specs
        schema:
          default: false
          type: boolean
      requestBody:
        content:
          application/vnd.atlas.2024-10-23+json:
            examples:
              Cluster:
                description: Cluster
                value:
                  clusterType: SHARDED
                  name: myCluster
                  replicationSpecs:
                  - regionConfigs:
                    - analyticsAutoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M40
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      analyticsSpecs:
                        diskSizeGB: 10
                        instanceSize: M40
                        nodeCount: 0
                      autoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M60
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      electableSpecs:
                        diskSizeGB: 10
                        instanceSize: M60
                        nodeCount: 3
                      priority: 7
                      providerName: AWS
                      readOnlySpecs:
                        diskSizeGB: 10
                        instanceSize: M60
                        nodeCount: 0
                      regionName: US_EAST_1
                    zoneName: Zone 1
                  - regionConfigs:
                    - analyticsAutoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M40
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      analyticsSpecs:
                        diskSizeGB: 10
                        instanceSize: M30
                        nodeCount: 0
                      autoScaling:
                        autoIndexing:
                          enabled: false
                        compute:
                          enabled: true
                          maxInstanceSize: M60
                          minInstanceSize: M30
                          scaleDownEnabled: true
                        diskGB:
                          enabled: true
                      electableSpecs:
                        diskSizeGB: 10
                        instanceSize: M40
                        nodeCount: 3
                      priority: 7
                      providerName: AWS
                      readOnlySpecs:
                        diskSizeGB: 10
                        instanceSize: M40
                        nodeCount: 0
                      regionName: US_EAST_1
                    zoneName: Zone 1
            schema:
              "$ref": "#/components/schemas/ClusterDescription20240805"
            x-xgen-version: '2024-10-23'
        description: Cluster to create in this project.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-10-23+json:
              schema:
                "$ref": "#/components/schemas/ClusterDescription20240805"
              x-xgen-version: '2024-10-23'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Cluster in One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters createCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tCreateGroupClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Creator
      x-xgen-changelog:
        '2025-06-05': Fixed a bug that previously permitted users to configure multiple
          regionConfigs for the same region and cloud provider within a replicationSpec
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createGroupCluster
      x-xgen-operation-id-override: createCluster
  "/api/atlas/v2/groups/{groupId}/clusters/provider/regions":
    get:
      description: Returns the list of regions available for the specified cloud provider
        at the specified tier. To use this resource, the requesting Service Account
        or API Key must have the Project Read Only role.
      operationId: listGroupClusterProviderRegions
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - description: Cloud providers whose regions to retrieve. When you specify multiple
          providers, the response can return only tiers and regions that support multi-cloud
          clusters.
        in: query
        name: providers
        schema:
          items:
            type: string
          type: array
      - description: Cluster tier for which to retrieve the regions.
        in: query
        name: tier
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasProviderRegionsView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Cloud Provider Regions
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters listClusterProviderRegions --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterProviderRegionsApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tListGroupClusterProviderRegionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listGroupClusterProviderRegions
      x-xgen-operation-id-override: listClusterProviderRegions
  "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade":
    post:
      description: "Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster
        in the specified project. To use this resource, the requesting Service Account
        or API Key must have the Project Cluster Manager role. Each project supports
        up to 25 clusters. \n\nThis endpoint can also be used to upgrade Flex clusters
        that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster)
        API or former M2/M5 clusters that have been migrated to Flex clusters, using
        `instanceSizeName` to “M2” or “M5” until January 2026. This functionality
        will be available until January 22, 2026, after which it will only be available
        for M0 clusters. Please use the Upgrade Flex Cluster endpoint instead."
      externalDocs:
        description: Upgrade Flex Cluster
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
      operationId: upgradeGroupClusterTenantUpgrade
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              "$ref": "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest"
        description: Details of the shared-tier cluster upgrade in the specified project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/LegacyAtlasCluster"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Upgrade One Shared-Tier Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters upgradeTenantUpgrade --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpgradeGroupClusterTenantUpgradeApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tUpgradeGroupClusterTenantUpgradeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgrade
      x-xgen-method-verb-override:
        customMethod: true
        verb: upgrade
      x-xgen-operation-id-override: upgradeTenantUpgrade
  "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless":
    post:
      deprecated: true
      description: |-
        This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the Upgrade Flex Cluster endpoint to upgrade Flex clusters.

         Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role.
      externalDocs:
        description: Upgrade Flex Cluster
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster
      operationId: upgradeGroupClusterTenantUpgradeToServerless
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              "$ref": "#/components/schemas/ServerlessInstanceDescription"
        description: Details of the shared-tier cluster upgrade in the specified project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ServerlessInstanceDescription"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Upgrade One Shared-Tier Cluster to One Serverless Instance
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters upgradeClusterToServerless --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpgradeGroupClusterTenantUpgradeToServerlessApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tUpgradeGroupClusterTenantUpgradeToServerlessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      x-sunset: '2025-02-05'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeGroupClusterTenantUpgradeToServerless
      x-xgen-method-verb-override:
        customMethod: true
        verb: upgrade
      x-xgen-operation-id-override: upgradeClusterToServerless
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}":
    delete:
      description: |-
        Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters.

        This endpoint can also be used on Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the Delete Flex Cluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: Delete Flex Cluster
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster
      operationId: deleteGroupCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Flag that indicates whether to retain backup snapshots for the
          deleted dedicated cluster.
        in: query
        name: retainBackups
        schema:
          type: boolean
      responses:
        '202':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Cluster from One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters deleteCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterApiParams{}\n\thttpResp,
          err := client.ClustersApi.\n\t\tDeleteGroupClusterWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteGroupCluster
      x-xgen-operation-id-override: deleteCluster
    get:
      description: |-
        Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters.

        This endpoint can also be used on Flex clusters that were created using the [Create Cluster](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster) endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the Get Flex Cluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}
      externalDocs:
        description: Get Flex Cluster
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
      operationId: getGroupCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Controls how hardware specification fields are returned in the
          response. When set to true, returns the original client-specified values
          and provides separate effective fields showing current operational values.
          When false (default), hardware specification fields show current operational
          values directly. Primarily used for autoscaling compatibility.
        in: header
        name: Use-Effective-Instance-Fields
        schema:
          default: false
          type: boolean
      - description: Controls how `replicationSpecs` are returned in the response.
          When set to `true`, returns the client-specified view in `replicationSpecs`
          and the actual cluster state in `effectiveReplicationSpecs`. When `false`
          (default), `replicationSpecs` contains the actual cluster state.
        in: header
        name: Use-Effective-Fields-Replication-Specs
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ClusterDescription20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Cluster from One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters getCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tGetGroupClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupCluster
      x-xgen-operation-id-override: getCluster
    patch:
      description: 'Updates the details for one cluster in the specified project.
        Clusters contain a group of hosts that maintain the same data set. This resource
        can update clusters with asymmetrically-sized shards. To update a cluster''s
        termination protection, the requesting Service Account or API Key must have
        the Project Owner role. For all other updates, the requesting Service Account
        or API Key must have the Project Cluster Manager role or the Project Replica
        Set Manager role. You can''t modify a paused cluster (`paused : true`). You
        must call this endpoint to set `paused : false`. After this endpoint responds
        with `paused : false`, you can call it again with the changes you want to
        make to the cluster. This feature is not available for serverless clusters.
        Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}'
      operationId: updateGroupCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: 'Controls how hardware specification fields are returned in the
          response after cluster updates. When set to true, returns the original client-specified
          values and provides separate effective fields showing current operational
          values. When false (default), hardware specification fields show current
          operational values directly. Note: When using this header with autoscaling
          enabled, MongoDB ignores `replicationSpecs` changes during updates. To intentionally
          override the `replicationSpecs`, disable this header.'
        in: header
        name: Use-Effective-Instance-Fields
        schema:
          default: false
          type: boolean
      - description: Controls how `replicationSpecs` fields are returned in the response.
          When set to `true`, stores the client's view of `replicationSpecs` and returns
          it in `replicationSpecs`, while the actual cluster state (including auto-scaled
          hardware and auto-added shards) is returned in `effectiveReplicationSpecs`.
          When `false` (default), `replicationSpecs` contains the actual cluster state.
        in: header
        name: Use-Effective-Fields-Replication-Specs
        schema:
          default: false
          type: boolean
      requestBody:
        content:
          application/vnd.atlas.2024-10-23+json:
            schema:
              "$ref": "#/components/schemas/ClusterDescription20240805"
            x-xgen-version: '2024-10-23'
        description: Cluster to update in the specified project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-10-23+json:
              schema:
                "$ref": "#/components/schemas/ClusterDescription20240805"
              x-xgen-version: '2024-10-23'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Cluster in One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters updateCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tUpdateGroupClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      - Project Replica Set Manager
      x-xgen-changelog:
        '2025-06-05': Fixed a bug that previously permitted users to configure multiple
          regionConfigs for the same region and cloud provider within a replicationSpec
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupCluster
      x-xgen-operation-id-override: updateCluster
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration":
    get:
      deprecated: true
      description: Returns the internal configuration of AutoScaling for sharded clusters.
        This endpoint can be used for diagnostic purposes to ensure that sharded clusters
        updated from older APIs have gained support for AutoScaling each shard independently.
      operationId: autoGroupClusterScalingConfiguration
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ClusterDescriptionAutoScalingModeConfiguration"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Auto Scaling Configuration for One Sharded Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters autoScalingConfiguration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AutoGroupClusterScalingConfigurationApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tAutoGroupClusterScalingConfigurationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoGroupClusterScalingConfiguration
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: autoScalingConfiguration
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports":
    get:
      description: Returns all Cloud Backup Snapshot Export Jobs associated with the
        specified Atlas cluster. To use this resource, the requesting Service Account
        or API Key must have the Project Atlas Admin role.
      operationId: listGroupClusterBackupExports
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Snapshot Export Jobs
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listBackupExports --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupExportsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupExportsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupExports
      x-xgen-operation-id-override: listBackupExports
    post:
      description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud
        Backups to an Export Bucket. To use this resource, the requesting Service
        Account or API Key must have the Project Backup Export Operator role.
      operationId: createGroupClusterBackupExport
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Snapshot Export Job
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups createBackupExport --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterBackupExportApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupClusterBackupExportWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Export Operator
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupExport
      x-xgen-operation-id-override: createBackupExport
  "/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 Service Account
        or API Key must have the Project Atlas Admin role.
      operationId: getGroupClusterBackupExport
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal character string that identifies the Export
          Job.
        in: path
        name: exportId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Snapshot Export Job
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getBackupExport --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupExportApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupExportWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupExport
      x-xgen-operation-id-override: getBackupExport
  "/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 Service Account or
        API Key must have the Project Backup Manager role.
      operationId: listGroupClusterBackupRestoreJobs
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedCloudBackupRestoreJobView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Restore Jobs for One Cluster
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listBackupRestoreJobs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupRestoreJobsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupRestoreJobsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupRestoreJobs
      x-xgen-operation-id-override: listBackupRestoreJobs
    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 processing the previously taken on-demand snapshot.

         To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role, Project Backup Export Operator role, or Project Backup Recovery Operator role.
      operationId: createGroupClusterBackupRestoreJob
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Restore Job of One Cluster
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups createBackupRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterBackupRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupClusterBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Export Operator
      - Project Backup Recovery Operator
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupRestoreJob
      x-xgen-operation-id-override: createBackupRestoreJob
  "/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 Service Account or API Key must
        have the Project Backup Manager role, Project Backup Export Operator role,
        or Project Backup Recovery Operator role.
      operationId: cancelGroupClusterBackupRestoreJob
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to remove.
        in: path
        name: restoreJobId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '405':
          "$ref": "#/components/responses/methodNotAllowed"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Cancel One Restore Job for One Cluster
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups cancelBackupRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CancelGroupClusterBackupRestoreJobApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tCancelGroupClusterBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}"
      x-rolesRequirements:
      - Project Backup Export Operator
      - Project Backup Recovery Operator
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelGroupClusterBackupRestoreJob
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: cancel
      x-xgen-operation-id-override: cancelBackupRestoreJob
    get:
      description: Returns one cloud backup restore job for one cluster from the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Backup Manager role.
      operationId: getGroupClusterBackupRestoreJob
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to return.
        in: path
        name: restoreJobId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Restore Job for One Cluster
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getBackupRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupRestoreJob
      x-xgen-operation-id-override: getBackupRestoreJob
  "/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 Service
        Account or API Key must have the Project Atlas Admin role. Deprecated versions:
        v2-{2023-01-01}'
      operationId: deleteGroupClusterBackupSchedule
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove All Cloud Backup Schedules
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups deleteClusterBackupSchedule --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterBackupScheduleApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tDeleteGroupClusterBackupScheduleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSchedule
      x-xgen-operation-id-override: deleteClusterBackupSchedule
    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 Service Account or API Key must have the Project Read Only role.
        Deprecated versions: v2-{2023-01-01}'
      operationId: getGroupClusterBackupSchedule
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Cloud Backup Schedule
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getBackupSchedule --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupScheduleApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupScheduleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSchedule
      x-xgen-method-verb-override:
        customMethod: 'False'
        verb: get
      x-xgen-operation-id-override: getBackupSchedule
    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
        Service Account or API Key must have the Project Owner role. Deprecated versions:
        v2-{2023-01-01}'
      operationId: updateGroupClusterBackupSchedule
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805"
        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.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Cloud Backup Schedule for One Cluster
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups updateBackupSchedule --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterBackupScheduleApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupClusterBackupScheduleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSchedule
      x-xgen-operation-id-override: updateBackupSchedule
  "/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 Service Account or API Key must have
        the Project Read Only role or Project Backup Manager role.
      operationId: listGroupClusterBackupSnapshots
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Desired point in time, expressed as the number of seconds that
          have elapsed since the UNIX epoch. If specified, returns the closest snapshot
          created before that point in time. Mutually exclusive with `oplogTs` and
          `oplogInc`.
        in: query
        name: pointInTimeUtcSeconds
        schema:
          format: int64
          type: integer
      - description: Oplog timestamp that represents the desired point in time. This
          is the first part of an Oplog timestamp. Must be used with `oplogInc`. Mutually
          exclusive with `pointInTimeUtcSeconds`.
        in: query
        name: oplogTs
        schema:
          format: int64
          type: integer
      - description: Oplog operation number that represents the desired point in time.
          This is the second part of an Oplog timestamp. Must be used with `oplogTs`.
          Mutually exclusive with `pointInTimeUtcSeconds`.
        in: query
        name: oplogInc
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedCloudBackupReplicaSetView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Replica Set Cloud Backups
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listBackupSnapshots --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupSnapshotsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupSnapshotsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshots
      x-xgen-operation-id-override: listBackupSnapshots
    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 processing the previously taken on-demand snapshot.

         To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role or Project Backup Creator role.
      operationId: takeGroupClusterBackupSnapshots
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Take One On-Demand Snapshot
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups takeSnapshots --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.TakeGroupClusterBackupSnapshotsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tTakeGroupClusterBackupSnapshotsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Creator
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeGroupClusterBackupSnapshots
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: take
      x-xgen-operation-id-override: takeSnapshots
  "/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 Service Account or API Key must
        have the Project Backup Manager role.
      operationId: deleteGroupClusterBackupSnapshotShardedCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Sharded Cluster Cloud Backup
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups deleteBackupShardedCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterBackupSnapshotShardedClusterApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tDeleteGroupClusterBackupSnapshotShardedClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshotShardedCluster
      x-xgen-operation-id-override: deleteBackupShardedCluster
    get:
      description: Returns one snapshot of one sharded cluster from the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role or Project Backup Manager role.
      operationId: getGroupClusterBackupSnapshotShardedCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshot"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Sharded Cluster Cloud Backup
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getBackupShardedCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupSnapshotShardedClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupSnapshotShardedClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshotShardedCluster
      x-xgen-operation-id-override: getBackupShardedCluster
  "/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 Service Account or API Key must
        have the Project Read Only role or Project Backup Manager role.
      operationId: listGroupClusterBackupSnapshotShardedClusters
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Sharded Cluster Cloud Backups
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listBackupShardedClusters --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupSnapshotShardedClustersApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupSnapshotShardedClustersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshotShardedClusters
      x-xgen-operation-id-override: listBackupShardedClusters
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}":
    delete:
      description: Removes the specified snapshot. To use this resource, the requesting
        Service Account or API Key must have the Project Backup Manager role.
      operationId: deleteGroupClusterBackupSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Replica Set Cloud Backup
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups deleteClusterBackupSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterBackupSnapshotApiParams{}\n\thttpResp,
          err := client.CloudBackupsApi.\n\t\tDeleteGroupClusterBackupSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}"
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshot
      x-xgen-operation-id-override: deleteClusterBackupSnapshot
    get:
      description: Returns one snapshot from the specified cluster. To use this resource,
        the requesting Service Account or API Key must have the Project Read Only
        role or Project Backup Manager role.
      operationId: getGroupClusterBackupSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DiskBackupReplicaSet"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Replica Set Cloud Backup
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getClusterBackupSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupSnapshotApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshot
      x-xgen-operation-id-override: getClusterBackupSnapshot
    patch:
      description: Changes the expiration date for one cloud backup snapshot for one
        cluster in the specified project, the requesting Service Account or API Key
        must have the Project Backup Manager role.
      operationId: updateGroupClusterBackupSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Expiration Date for One Cloud Backup
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups updateBackupSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterBackupSnapshotApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupClusterBackupSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSnapshot
      x-xgen-operation-id-override: updateBackupSnapshot
  "/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 Service Account or API Key must
        have the Project Read Only role.
      operationId: listGroupClusterBackupCheckpoints
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasCheckpointView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Legacy Backup Checkpoints
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup listClusterBackupCheckpoints --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupCheckpointsApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tListGroupClusterBackupCheckpointsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterBackupCheckpoints
      x-xgen-operation-id-override: listClusterBackupCheckpoints
  "/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 Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupClusterBackupCheckpoint
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: Human-readable label that identifies the cluster that contains
          the checkpoints that you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasCheckpointView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Legacy Backup Checkpoint
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup getClusterBackupCheckpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupCheckpointApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tGetGroupClusterBackupCheckpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterBackupCheckpoint
      x-xgen-operation-id-override: getClusterBackupCheckpoint
  "/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: listGroupClusterCollStatPinnedNamespaces
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                "$ref": "#/components/schemas/PinnedNamespaces"
              x-xgen-version: '2023-11-15'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Pinned Namespaces
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics listPinnedNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterCollStatPinnedNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tListGroupClusterCollStatPinnedNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupClusterCollStatPinnedNamespaces
      x-xgen-method-verb-override:
        customMethod: true
        verb: listNamespaces
      x-xgen-operation-id-override: listPinnedNamespaces
    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: updateGroupClusterCollStatPinnedNamespaces
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '201':
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                "$ref": "#/components/schemas/PinnedNamespaces"
              x-xgen-version: '2023-11-15'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add Pinned Namespaces
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics updatePinnedNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterCollStatPinnedNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tUpdateGroupClusterCollStatPinnedNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/updateGroupClusterCollStatPinnedNamespaces
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: updateNamespaces
      x-xgen-operation-id-override: updatePinnedNamespaces
    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: pinGroupClusterCollStatPinnedNamespaces
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '201':
          content:
            application/vnd.atlas.2023-11-15+json:
              schema:
                "$ref": "#/components/schemas/PinnedNamespaces"
              x-xgen-version: '2023-11-15'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Pin Namespaces
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics pinNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.PinGroupClusterCollStatPinnedNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tPinGroupClusterCollStatPinnedNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinGroupClusterCollStatPinnedNamespaces
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: pinNamespaces
      x-xgen-operation-id-override: pinNamespaces
  "/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: unpinGroupClusterCollStatUnpinNamespaces
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Unpin Namespaces
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics unpinNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UnpinGroupClusterCollStatUnpinNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tUnpinGroupClusterCollStatUnpinNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinGroupClusterCollStatUnpinNamespaces
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: unpinNamespaces
      x-xgen-operation-id-override: unpinNamespaces
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes":
    post:
      deprecated: true
      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 Service Account
        or API Key must have the Project Data Access Admin role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: createGroupClusterFtsIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Atlas Search Index
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch createClusterFtsIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterFtsIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tCreateGroupClusterFtsIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Search Index Editor
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterFtsIndex
      x-xgen-operation-id-override: createClusterFtsIndex
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}":
    get:
      deprecated: true
      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 Service Account or API Key
        must have the Project Data Access Read Write role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: listGroupClusterFtsIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - 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:
                description: List of Atlas Search indexes that MongoDB Cloud returns
                  for this request.
                items:
                  "$ref": "#/components/schemas/ClusterSearchIndex"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Atlas Search Indexes for One Collection
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch listClusterFtsIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterFtsIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tListGroupClusterFtsIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true"
      x-rolesRequirements:
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Search Index Editor
      - Project Stream Processing Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterFtsIndex
      x-xgen-method-verb-override:
        customMethod: false
        verb: list
      x-xgen-operation-id-override: listClusterFtsIndex
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}":
    delete:
      deprecated: true
      description: Removes one Atlas Search index that you identified with its unique
        ID. To use this resource, the requesting Service Account or API Key must have
        the Project Data Access Admin role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: deleteGroupClusterFtsIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Atlas Search Index
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch deleteClusterFtsIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterFtsIndexApiParams{}\n\thttpResp,
          err := client.AtlasSearchApi.\n\t\tDeleteGroupClusterFtsIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}"
      x-rolesRequirements:
      - Project Search Index Editor
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterFtsIndex
      x-xgen-operation-id-override: deleteClusterFtsIndex
    get:
      deprecated: true
      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
        Service Account or API Key must have the Project Data Access Read Write role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: getGroupClusterFtsIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the Application
          Search [index](https://dochub.mongodb.org/core/index-definitions-fts). 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ClusterSearchIndex"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Atlas Search Index
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch getClusterFtsIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterFtsIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tGetGroupClusterFtsIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true"
      x-rolesRequirements:
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Search Index Editor
      - Project Stream Processing Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterFtsIndex
      x-xgen-operation-id-override: getClusterFtsIndex
    patch:
      deprecated: true
      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
        Service Account or API Key must have the Project Data Access Admin role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: updateGroupClusterFtsIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the Atlas
          Search [index](https://dochub.mongodb.org/core/index-definitions-fts). 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Atlas Search Index
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch updateClusterFtsIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterFtsIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tUpdateGroupClusterFtsIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Search Index Editor
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterFtsIndex
      x-xgen-operation-id-override: updateClusterFtsIndex
  "/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 Service
        Account or API Key must have the Project Read Only role. Deprecated versions:
        v2-{2023-02-01}, v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: getGroupClusterGlobalWrites
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              examples:
                200 Example:
                  description: 200 Example
                  value:
                    customZoneMapping:
                      DE: 32b6e34b3d91647abb20e7b8
                      US-VA: 32b6e34b3d91647abb20e7b8
                    managedNamespaces:
                    - collection: collectionNameExample
                      customShardKey: myShardKey
                      db: DatabaseExample
                      isCustomShardKeyHashed: false
                      isShardKeyUnique: false
                      numInitialChunks: 42
                      presplitHashedZones: false
                    selfManagedSharding: true
              schema:
                "$ref": "#/components/schemas/GeoSharding20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Managed Namespace in One Global Cluster
      tags:
      - Global Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api globalClusters getClusterGlobalWrites --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterGlobalWritesApiParams{}\n\tsdkResp,
          httpResp, err := client.GlobalClustersApi.\n\t\tGetGroupClusterGlobalWritesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getGroupClusterGlobalWrites
      x-xgen-operation-id-override: getClusterGlobalWrites
  "/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 Service Account or API Key must
        have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: deleteGroupClusterGlobalWriteCustomZoneMapping
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              examples:
                200 Example:
                  description: 200 Example
                  value:
                    customZoneMapping:
                      DE: 32b6e34b3d91647abb20e7b8
                      US-VA: 32b6e34b3d91647abb20e7b8
                    managedNamespaces:
                    - collection: collectionNameExample
                      customShardKey: myShardKey
                      db: DatabaseExample
                      isCustomShardKeyHashed: false
                      isShardKeyUnique: false
                      numInitialChunks: 42
                      presplitHashedZones: false
                    selfManagedSharding: true
              schema:
                "$ref": "#/components/schemas/GeoSharding20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove All Custom Zone Mappings from One Global Cluster
      tags:
      - Global Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api globalClusters deleteCustomZoneMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterGlobalWriteCustomZoneMappingApiParams{}\n\thttpResp,
          err := client.GlobalClustersApi.\n\t\tDeleteGroupClusterGlobalWriteCustomZoneMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteGroupClusterGlobalWriteCustomZoneMapping
      x-xgen-operation-id-override: deleteCustomZoneMapping
    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 Service Account or
        API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01},
        v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: createGroupClusterGlobalWriteCustomZoneMapping
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/CustomZoneMappings"
            x-xgen-version: '2024-08-05'
        description: Custom zone mapping to add to the specified global cluster.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              examples:
                200 Example:
                  description: 200 Example
                  value:
                    customZoneMapping:
                      DE: 32b6e34b3d91647abb20e7b8
                      US-VA: 32b6e34b3d91647abb20e7b8
                    managedNamespaces:
                    - collection: collectionNameExample
                      customShardKey: myShardKey
                      db: DatabaseExample
                      isCustomShardKeyHashed: false
                      isShardKeyUnique: false
                      numInitialChunks: 42
                      presplitHashedZones: false
                    selfManagedSharding: true
              schema:
                "$ref": "#/components/schemas/GeoSharding20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One Custom Zone Mapping to One Global Cluster
      tags:
      - Global Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api globalClusters createCustomZoneMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterGlobalWriteCustomZoneMappingApiParams{}\n\tsdkResp,
          httpResp, err := client.GlobalClustersApi.\n\t\tCreateGroupClusterGlobalWriteCustomZoneMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createGroupClusterGlobalWriteCustomZoneMapping
      x-xgen-operation-id-override: createCustomZoneMapping
  "/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
        Service Account or API Key must have the Project Data Access Admin role. Deprecated
        versions: v2-{2023-02-01}, v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: deleteGroupClusterGlobalWriteManagedNamespaces
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - "$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.2024-08-05+json:
              examples:
                200 Example:
                  description: 200 Example
                  value:
                    customZoneMapping:
                      DE: 32b6e34b3d91647abb20e7b8
                      US-VA: 32b6e34b3d91647abb20e7b8
                    managedNamespaces:
                    - collection: collectionNameExample
                      customShardKey: myShardKey
                      db: DatabaseExample
                      isCustomShardKeyHashed: false
                      isShardKeyUnique: false
                      numInitialChunks: 42
                      presplitHashedZones: false
                    selfManagedSharding: true
              schema:
                "$ref": "#/components/schemas/GeoSharding20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Managed Namespace from One Global Cluster
      tags:
      - Global Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api globalClusters deleteManagedNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterGlobalWriteManagedNamespacesApiParams{}\n\thttpResp,
          err := client.GlobalClustersApi.\n\t\tDeleteGroupClusterGlobalWriteManagedNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces"
      x-rolesRequirements:
      - Project Data Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteGroupClusterGlobalWriteManagedNamespaces
      x-xgen-operation-id-override: deleteManagedNamespaces
    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 Service
        Account or API Key must have the Project Data Access Admin role. Deprecated
        versions: v2-{2023-02-01}, v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: createGroupClusterGlobalWriteManagedNamespace
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ManagedNamespaces"
            x-xgen-version: '2024-08-05'
        description: Managed namespace to create within the specified global cluster.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              examples:
                200 Example:
                  description: 200 Example
                  value:
                    customZoneMapping:
                      DE: 32b6e34b3d91647abb20e7b8
                      US-VA: 32b6e34b3d91647abb20e7b8
                    managedNamespaces:
                    - collection: collectionNameExample
                      customShardKey: myShardKey
                      db: DatabaseExample
                      isCustomShardKeyHashed: false
                      isShardKeyUnique: false
                      numInitialChunks: 42
                      presplitHashedZones: false
                    selfManagedSharding: true
              schema:
                "$ref": "#/components/schemas/GeoSharding20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '405':
          "$ref": "#/components/responses/methodNotAllowed"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Managed Namespace in One Global Cluster
      tags:
      - Global Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api globalClusters createManagedNamespace --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterGlobalWriteManagedNamespaceApiParams{}\n\tsdkResp,
          httpResp, err := client.GlobalClustersApi.\n\t\tCreateGroupClusterGlobalWriteManagedNamespaceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Data Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createGroupClusterGlobalWriteManagedNamespace
      x-xgen-operation-id-override: createManagedNamespace
  "/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 Service Account or API Key must have the
        Project Data Access Admin role or the Project Index Manager role.
      externalDocs:
        description: Rolling Index Builds on Replica Sets
        url: https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/
      operationId: createGroupClusterIndexRollingIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Rolling Index
      tags:
      - Rolling Index
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api rollingIndex createRollingIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterIndexRollingIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.RollingIndexApi.\n\t\tCreateGroupClusterIndexRollingIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Data Access Admin
      - Project Index Manager
      x-xgen-changelog:
        '2025-05-08': Corrects an issue where the endpoint would allow a rolling index
          build to be initiated while there was already an index build in progress.
          The endpoint now returns 400 if an index build is already in progress.
        '2026-04-06': Corrects an issue where index creation was throwing a 500 error
          instead of a 409 error when there was an existing index with the same name.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createGroupClusterIndexRollingIndex
      x-xgen-method-verb-override:
        customMethod: false
        verb: createRollingIndex
      x-xgen-operation-id-override: createRollingIndex
  "/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
        Service Account or 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: listGroupClusterOnlineArchives
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedOnlineArchiveView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Online Archives for One Cluster
      tags:
      - Online Archive
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api onlineArchive listOnlineArchives --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterOnlineArchivesApiParams{}\n\tsdkResp,
          httpResp, err := client.OnlineArchiveApi.\n\t\tListGroupClusterOnlineArchivesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listGroupClusterOnlineArchives
      x-xgen-operation-id-override: listOnlineArchives
    post:
      description: Creates one online archive. This archive stores data from one cluster
        within one project. To use this resource, the requesting Service Account or
        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: createGroupClusterOnlineArchive
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Online Archive
      tags:
      - Online Archive
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api onlineArchive createOnlineArchive --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterOnlineArchiveApiParams{}\n\tsdkResp,
          httpResp, err := client.OnlineArchiveApi.\n\t\tCreateGroupClusterOnlineArchiveWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Data Access Admin
      x-xgen-changelog:
        '2023-08-02': If 'criteria':'DATE' is specified, then you must specify 'DATE'
          values in partition fields
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createGroupClusterOnlineArchive
      x-xgen-operation-id-override: createOnlineArchive
  "/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 Service Account or API Key must have the Project
        Data Access Read Only or higher role. The API does not support direct calls
        with the json response schema. You must request a gzip response schema using
        an accept header of the format: `Accept: application/vnd.atlas.YYYY-MM-DD+gzip`.'
      externalDocs:
        description: Online Archive
        url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive
      operationId: downloadGroupClusterOnlineArchiveQueryLogs
      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:
          example: 1636481348
          format: int64
          minimum: 1199145600
          type: integer
      - 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:
          example: 1636481348
          format: int64
          minimum: 1199145600
          type: integer
      - 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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - 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:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+gzip:
              schema:
                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.
                format: binary
                type: string
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Download Online Archive Query Logs
      tags:
      - Online Archive
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api onlineArchive downloadQueryLogs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DownloadGroupClusterOnlineArchiveQueryLogsApiParams{}\n\tsdkResp,
          httpResp, err := client.OnlineArchiveApi.\n\t\tDownloadGroupClusterOnlineArchiveQueryLogsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz" \
            --output "file_name.gz"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz" \
            --output "file_name.gz"
      x-rolesRequirements:
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadGroupClusterOnlineArchiveQueryLogs
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: download
      x-xgen-operation-id-override: downloadQueryLogs
  "/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 Service Account or
        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: deleteGroupClusterOnlineArchive
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Online Archive
      tags:
      - Online Archive
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api onlineArchive deleteOnlineArchive --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterOnlineArchiveApiParams{}\n\thttpResp,
          err := client.OnlineArchiveApi.\n\t\tDeleteGroupClusterOnlineArchiveWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}"
      x-rolesRequirements:
      - Project Data Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteGroupClusterOnlineArchive
      x-xgen-operation-id-override: deleteOnlineArchive
    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
        Service Account or 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: getGroupClusterOnlineArchive
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/BackupOnlineArchive"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Online Archive
      tags:
      - Online Archive
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api onlineArchive getOnlineArchive --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterOnlineArchiveApiParams{}\n\tsdkResp,
          httpResp, err := client.OnlineArchiveApi.\n\t\tGetGroupClusterOnlineArchiveWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getGroupClusterOnlineArchive
      x-xgen-operation-id-override: getOnlineArchive
    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
        Service Account or 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: updateGroupClusterOnlineArchive
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Online Archive
      tags:
      - Online Archive
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api onlineArchive updateOnlineArchive --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterOnlineArchiveApiParams{}\n\tsdkResp,
          httpResp, err := client.OnlineArchiveApi.\n\t\tUpdateGroupClusterOnlineArchiveWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Data Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateGroupClusterOnlineArchive
      x-xgen-operation-id-override: updateOnlineArchive
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation":
    delete:
      description: Ends a cluster outage simulation. To use this resource, the requesting
        Service Account or API Key must have the Project Cluster Manager role, Project
        Cluster Resilience Tester role, or Project Replica Set Manager role.
      externalDocs:
        description: Cluster Outage Simulation
        url: https://dochub.mongodb.org/core/test-regional-outage
      operationId: endGroupClusterOutageSimulation
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ClusterOutageSimulation"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: End One Outage Simulation
      tags:
      - Cluster Outage Simulation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusterOutageSimulation endOutageSimulation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.EndGroupClusterOutageSimulationApiParams{}\n\thttpResp,
          err := client.ClusterOutageSimulationApi.\n\t\tEndGroupClusterOutageSimulationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation"
      x-rolesRequirements:
      - Project Cluster Manager
      - Project Cluster Resilience Tester
      - Project Replica Set Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endGroupClusterOutageSimulation
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: end
      x-xgen-operation-id-override: endOutageSimulation
    get:
      description: Returns one outage simulation for one cluster.
      externalDocs:
        description: Cluster Outage Simulation
        url: https://dochub.mongodb.org/core/test-regional-outage
      operationId: getGroupClusterOutageSimulation
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ClusterOutageSimulation"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Outage Simulation
      tags:
      - Cluster Outage Simulation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusterOutageSimulation getOutageSimulation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterOutageSimulationApiParams{}\n\tsdkResp,
          httpResp, err := client.ClusterOutageSimulationApi.\n\t\tGetGroupClusterOutageSimulationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true"
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getGroupClusterOutageSimulation
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getOutageSimulation
    post:
      description: Starts a cluster outage simulation. To use this resource, the requesting
        Service Account or API Key must have the Project Cluster Manager role, Project
        Cluster Resilience Tester role, or Project Replica Set Manager role.
      externalDocs:
        description: Cluster Outage Simulation
        url: https://dochub.mongodb.org/core/test-regional-outage
      operationId: startGroupClusterOutageSimulation
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Start One Outage Simulation
      tags:
      - Cluster Outage Simulation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusterOutageSimulation startOutageSimulation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.StartGroupClusterOutageSimulationApiParams{}\n\tsdkResp,
          httpResp, err := client.ClusterOutageSimulationApi.\n\t\tStartGroupClusterOutageSimulationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      - Project Cluster Resilience Tester
      - Project Replica Set Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startGroupClusterOutageSimulation
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: start
      x-xgen-operation-id-override: startOutageSimulation
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions":
    get:
      description: Returns the indexes that the Performance Advisor suggests to drop.
        The Performance Advisor suggests dropping unused, redundant, and hidden indexes
        to improve write performance and increase storage space. To use this resource,
        the requesting Service Account or API Key must have the Project Read Only
        role.
      operationId: listGroupClusterPerformanceAdvisorDropIndexSuggestions
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/DropIndexSuggestionsResponse"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Suggested Indexes to Drop
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor listDropIndexSuggestions --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterPerformanceAdvisorDropIndexSuggestionsApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tListGroupClusterPerformanceAdvisorDropIndexSuggestionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorDropIndexSuggestions
      x-xgen-operation-id-override: listDropIndexSuggestions
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice":
    get:
      description: Returns the schema suggestions that the Performance Advisor detects.
        The Performance Advisor provides holistic schema recommendations for your
        cluster by sampling documents in your most active collections and collections
        with slow-running queries. To use this resource, the requesting Service Account
        or API Key must have the Project Read Only role.
      operationId: listGroupClusterPerformanceAdvisorSchemaAdvice
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/SchemaAdvisorResponse"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Schema Advice
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor listSchemaAdvice --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterPerformanceAdvisorSchemaAdviceApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tListGroupClusterPerformanceAdvisorSchemaAdviceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorSchemaAdvice
      x-xgen-operation-id-override: listSchemaAdvice
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/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
        Service Account or API Key must have the Project Read Only role.
      operationId: listGroupClusterPerformanceAdvisorSuggestedIndexes
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Process IDs from which to retrieve suggested indexes. A `processId`
          is a 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. To include multiple
          `processIds`, pass the parameter multiple times delimited with an ampersand
          (`&`) between each `processId`.
        in: query
        name: processIds
        schema:
          items:
            pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
            type: string
          type: array
        style: form
      - 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:
          items:
            type: string
          type: array
        style: form
      - 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 **until** parameter, the endpoint returns data covering from the **since** value and the current time.
          - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: since
        schema:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: |-
          Date and time up until 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 specify the **until** parameter, you must specify the **since** parameter.
          - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: until
        schema:
          format: int64
          minimum: 1199145600000
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PerformanceAdvisorResponse"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Suggested Indexes
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor listClusterSuggestedIndexes --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterPerformanceAdvisorSuggestedIndexesApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tListGroupClusterPerformanceAdvisorSuggestedIndexesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupClusterPerformanceAdvisorSuggestedIndexes
      x-xgen-operation-id-override: listClusterSuggestedIndexes
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs":
    get:
      description: 'Returns the advanced configuration details for one cluster in
        the specified project. Clusters contain a group of hosts that maintain the
        same data set. Advanced configuration details include the read/write concern,
        index and oplog limits, and other database settings. This feature isn''t available
        for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters,
        or serverless clusters. To use this resource, the requesting Service Account
        or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: getGroupClusterProcessArgs
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ClusterDescriptionProcessArgs20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Advanced Configuration Options for One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters getProcessArgs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterProcessArgsApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tGetGroupClusterProcessArgsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterProcessArgs
      x-xgen-operation-id-override: getProcessArgs
    patch:
      description: 'Updates the advanced configuration details for one cluster in
        the specified project. Clusters contain a group of hosts that maintain the
        same data set. Advanced configuration details include the read/write concern,
        index and oplog limits, and other database settings. To use this resource,
        the requesting Service Account or API Key must have the Project Cluster Manager
        role. This feature isn''t available for `M0` free clusters, `M2` and `M5`
        shared-tier clusters, flex clusters, or serverless clusters. Deprecated versions:
        v2-{2023-01-01}'
      externalDocs:
        description: Global Clusters
        url: https://www.mongodb.com/docs/atlas/global-clusters/
      operationId: updateGroupClusterProcessArgs
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ClusterDescriptionProcessArgs20240805"
            x-xgen-version: '2024-08-05'
        description: Advanced configuration details to add for one cluster in the
          specified project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ClusterDescriptionProcessArgs20240805"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Advanced Configuration Options for One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters updateProcessArgs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterProcessArgsApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tUpdateGroupClusterProcessArgsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateGroupClusterProcessArgs
      x-xgen-operation-id-override: updateProcessArgs
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries":
    get:
      description: Returns a list of query shape statistics summaries for a given
        cluster. Query shape statistics provide performance insights about MongoDB
        queries, helping users identify problematic query patterns and potential optimizations.
      operationId: listGroupClusterQueryShapeInsightSummaries
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: |-
          Date and time from which to retrieve query shape statistics. 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 **until** parameter, the endpoint returns data covering from the **since** value and the current time.
          - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: since
        schema:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: |-
          Date and time up until which to retrieve query shape statistics. 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 specify the **until** parameter, you must specify the **since** parameter.
          - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: until
        schema:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: Process IDs from which to retrieve query shape statistics. A
          `processId` is a 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. To include
          multiple `processId`, pass the parameter multiple times delimited with an
          ampersand (`&`) between each `processId`.
        in: query
        name: processIds
        schema:
          items:
            pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
            type: string
          maxItems: 10
          type: array
        style: form
      - description: 'Namespaces from which to retrieve query shape statistics. 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:
          items:
            type: string
          maxItems: 10
          type: array
        style: form
      - description: Retrieve query shape statistics matching specified MongoDB commands.
          To include multiple commands, pass the parameter multiple times delimited
          with an ampersand (`&`) between each command. The currently supported parameters
          are find, distinct, and aggregate. Omit this parameter to return results
          for all supported commands.
        in: query
        name: commands
        schema:
          description: MongoDB commands from which to retrieve query statistics. To
            include multiple commands, pass the parameter multiple times delimited
            with an ampersand (`&`) between each command. Omit this parameter to return
            results for all supported commands.
          items:
            enum:
            - find
            - distinct
            - aggregate
            type: string
          maxItems: 3
          type: array
          uniqueItems: true
        style: form
      - description: Maximum number of query statistic summaries to return.
        in: query
        name: nSummaries
        schema:
          default: 100
          format: int64
          maximum: 100
          minimum: 1
          type: integer
      - description: Query shape statistics data series to retrieve. A series represents
          a specific metric about query execution. To include multiple series, pass
          the parameter multiple times delimited with an ampersand (`&`) between each
          series. Omit this parameter to return results for all available series.
        in: query
        name: series
        schema:
          description: Query shape statistics data series to retrieve. A series represents
            a specific metric about query execution. To include multiple series, pass
            the parameter multiple times delimited with an ampersand (`&`) between
            each series. Omit this parameter to return results for all available series.
          items:
            enum:
            - TOTAL_EXECUTION_TIME
            - AVG_EXECUTION_TIME
            - EXECUTION_COUNT
            - KEYS_EXAMINED
            - DOCS_EXAMINED
            - DOCS_RETURNED
            - TOTAL_TIME_TO_RESPONSE
            - BYTES_READ
            - CPU_TIME
            - KEYS_EXAMINED_RETURNED
            - DOCS_EXAMINED_RETURNED
            - LAST_EXECUTION_TIME
            - P50_EXECUTION_TIME
            - P90_EXECUTION_TIME
            - P99_EXECUTION_TIME
            type: string
          maxItems: 15
          type: array
          uniqueItems: true
        style: form
      - description: A list of SHA256 hashes of desired query shapes, output by MongoDB
          commands like `$queryStats` and $explain or slow query logs. To include
          multiple series, pass the parameter multiple times delimited with an ampersand
          (`&`) between each series. Omit this parameter to return results for all
          available series.
        in: query
        name: queryShapeHashes
        schema:
          description: A list of SHA256 hashes of desired query shapes, output by
            MongoDB commands like `$queryStats` and `$explain` or slow query logs.
            To include multiple series, pass the parameter multiple times delimited
            with an ampersand (`&`) between each series. Omit this parameter to return
            results for all available series.
          items:
            pattern: "^([a-fA-F0-9]{64})$"
            type: string
          maxItems: 10
          type: array
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/QueryStatsSummaryListResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Query Statistic Summaries
      tags:
      - Query Shape Insights
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api queryShapeInsights listQueryShapeSummaries --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterQueryShapeInsightSummariesApiParams{}\n\tsdkResp,
          httpResp, err := client.QueryShapeInsightsApi.\n\t\tListGroupClusterQueryShapeInsightSummariesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/listGroupClusterQueryShapeInsightSummaries
      x-xgen-operation-id-override: listQueryShapeSummaries
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details":
    get:
      description: Returns the metadata and statistics summary for a given query shape
        hash.
      operationId: getGroupClusterQueryShapeInsightDetails
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: |-
          Date and time from which to retrieve query shape statistics. 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 **until** parameter, the endpoint returns data covering from the **since** value and the current time.
          - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: since
        schema:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: |-
          Date and time up until which to retrieve query shape statistics. 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 specify the **until** parameter, you must specify the **since** parameter.
          - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
        in: query
        name: until
        schema:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: Process IDs from which to retrieve query shape statistics. A
          `processId` is a 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. To include
          multiple `processIds`, pass the parameter multiple times delimited with
          an ampersand (`&`) between each `processId`.
        in: query
        name: processIds
        schema:
          items:
            pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
            type: string
          maxItems: 10
          type: array
        style: form
      - description: A SHA256 hash of a query shape, output by MongoDB commands like
          `$queryStats` and `$explain` or slow query logs.
        in: path
        name: queryShapeHash
        required: true
        schema:
          pattern: "^([a-fA-F0-9]{64})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/QueryStatsDetailsResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Query Shape Details
      tags:
      - Query Shape Insights
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api queryShapeInsights getQueryShapeDetails --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterQueryShapeInsightDetailsApiParams{}\n\tsdkResp,
          httpResp, err := client.QueryShapeInsightsApi.\n\t\tGetGroupClusterQueryShapeInsightDetailsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShapeInsightDetails
      x-xgen-operation-id-override: getQueryShapeDetails
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes":
    get:
      description: Returns a list of query shapes for one cluster. Query shapes may
        be filtered by their status; at present, this endpoint supports only the REJECTED
        status.
      operationId: listGroupClusterQueryShapes
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: The status of query shapes to retrieve. Only REJECTED status
          is supported. If omitted, defaults to REJECTED.
        in: query
        name: status
        schema:
          default: REJECTED
          enum:
          - REJECTED
          type: string
      - "$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.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/PaginatedQueryShapes"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Query Shapes
      tags:
      - Query Shape Insights
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api queryShapeInsights listClusterQueryShapes --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterQueryShapesApiParams{}\n\tsdkResp,
          httpResp, err := client.QueryShapeInsightsApi.\n\t\tListGroupClusterQueryShapesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/listGroupClusterQueryShapes
      x-xgen-operation-id-override: listClusterQueryShapes
      x-xgen-version: '2025-03-12'
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}":
    get:
      description: Returns the details for a single query shape. This endpoint only
        returns query shapes with REJECTED status. If the specified query shape hash
        does not correspond to a rejected query shape, a 404 Not Found error is returned.
      operationId: getGroupClusterQueryShape
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: A SHA256 hash of a query shape, output by MongoDB commands like
          `$queryStats` and `$explain` or slow query logs.
        in: path
        name: queryShapeHash
        required: true
        schema:
          pattern: "^([a-fA-F0-9]{64})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/QueryShapeResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Query Shape
      tags:
      - Query Shape Insights
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api queryShapeInsights getClusterQueryShape --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterQueryShapeApiParams{}\n\tsdkResp,
          httpResp, err := client.QueryShapeInsightsApi.\n\t\tGetGroupClusterQueryShapeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/getGroupClusterQueryShape
      x-xgen-operation-id-override: getClusterQueryShape
      x-xgen-version: '2025-03-12'
    patch:
      description: 'Updates the rejection status of a query shape. Use this endpoint
        to reject a query shape (preventing it from executing on the cluster) or to
        unreject a previously rejected query shape (allowing it to execute again).
        This operation is idempotent: rejecting an already rejected query shape or
        unrejecting an already unrejected query shape will return 200 OK.'
      operationId: updateGroupClusterQueryShape
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: A SHA256 hash of a query shape, output by MongoDB commands like
          `$queryStats` and `$explain` or slow query logs.
        in: path
        name: queryShapeHash
        required: true
        schema:
          pattern: "^([a-fA-F0-9]{64})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-03-12+json:
            schema:
              "$ref": "#/components/schemas/QueryShapeUpdateRequest"
        description: The desired rejection status for the query shape. Provide REJECTED
          to block the query shape from executing, or UNREJECTED to allow it to execute.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/QueryShapeResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Query Shape Rejection Status
      tags:
      - Query Shape Insights
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api queryShapeInsights updateClusterQueryShape --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterQueryShapeApiParams{}\n\tsdkResp,
          httpResp, err := client.QueryShapeInsightsApi.\n\t\tUpdateGroupClusterQueryShapeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Data Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Query-Shape-Insights/operation/updateGroupClusterQueryShape
      x-xgen-operation-id-override: updateClusterQueryShape
      x-xgen-version: '2025-03-12'
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries":
    post:
      description: 'Starts a failover test for the specified cluster in the specified
        project. Clusters contain a group of hosts that maintain the same data set.
        A failover test checks how MongoDB Cloud handles the failure of the cluster''s
        primary node. During the test, MongoDB Cloud shuts down the primary node and
        elects a new primary. To use this resource, the requesting Service Account
        or API Key must have the Project Cluster Manager role. Deprecated versions:
        v2-{2023-01-01}'
      operationId: restartGroupClusterPrimaries
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Test Failover for One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters restartPrimaries --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RestartGroupClusterPrimariesApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tRestartGroupClusterPrimariesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/restartGroupClusterPrimaries
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: restartPrimaries
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs":
    get:
      deprecated: true
      description: |-
        Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting Service Account or 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. 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: listGroupClusterRestoreJobs
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: Human-readable label that identifies the cluster with the snapshot
          you want to return.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedRestoreJobView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Legacy Backup Restore Jobs
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup listClusterRestoreJobs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterRestoreJobsApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tListGroupClusterRestoreJobsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterRestoreJobs
      x-xgen-operation-id-override: listClusterRestoreJobs
    post:
      deprecated: true
      description: Restores one legacy backup for one cluster in the specified project.
        To use this resource, the requesting Service Account or 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. 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: createGroupClusterRestoreJob
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Legacy Backup Restore Job
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup createClusterRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tCreateGroupClusterRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createGroupClusterRestoreJob
      x-xgen-operation-id-override: createClusterRestoreJob
  "/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 Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: getGroupClusterRestoreJob
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job.
        in: path
        name: jobId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/BackupRestoreJob"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Legacy Backup Restore Job
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup getClusterRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tGetGroupClusterRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterRestoreJob
      x-xgen-operation-id-override: getClusterRestoreJob
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment":
    delete:
      description: Deletes the Search Nodes for the specified cluster.
      operationId: deleteGroupClusterSearchDeployment
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete Search Nodes
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch deleteClusterSearchDeployment --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterSearchDeploymentApiParams{}\n\thttpResp,
          err := client.AtlasSearchApi.\n\t\tDeleteGroupClusterSearchDeploymentWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment"
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchDeployment
      x-xgen-operation-id-override: deleteClusterSearchDeployment
    get:
      description: 'Returns the Search Nodes for the specified cluster. Deprecated
        versions: v2-{2024-05-30}, v2-{2023-01-01}'
      operationId: getGroupClusterSearchDeployment
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/ApiSearchDeploymentResponseView"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Search Nodes
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch getClusterSearchDeployment --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterSearchDeploymentApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tGetGroupClusterSearchDeploymentWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-changelog:
        '2025-03-12': Updates the return of the API when no nodes exist, the endpoint
          returns 200 with an empty JSON ({}) instead of 400.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchDeployment
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getClusterSearchDeployment
    patch:
      description: 'Updates the Search Nodes for the specified cluster. Deprecated
        versions: v2-{2023-01-01}'
      operationId: updateGroupClusterSearchDeployment
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/ApiSearchDeploymentRequestView"
        description: Updates the Search Nodes for the specified cluster.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/ApiSearchDeploymentResponseView"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Search Nodes
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch updateClusterSearchDeployment --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterSearchDeploymentApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tUpdateGroupClusterSearchDeploymentWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchDeployment
      x-xgen-operation-id-override: updateClusterSearchDeployment
    post:
      description: Creates Search Nodes for the specified cluster.
      operationId: createGroupClusterSearchDeployment
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/ApiSearchDeploymentRequestView"
        description: Creates Search Nodes for the specified cluster.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/ApiSearchDeploymentResponseView"
              x-xgen-version: '2024-05-30'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create Search Nodes
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch createClusterSearchDeployment --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterSearchDeploymentApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tCreateGroupClusterSearchDeploymentWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterSearchDeployment
      x-xgen-operation-id-override: createClusterSearchDeployment
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes":
    get:
      description: Returns all Atlas Search indexes on the specified cluster. Atlas
        Search indexes contain the indexed fields and the analyzers used to create
        the indexes. To use this resource, the requesting Service Account or API Key
        must have the Project Data Access Read Write role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: listGroupClusterSearchIndexes
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                description: List of Atlas Search indexes that MongoDB Cloud returns
                  for this request.
                items:
                  "$ref": "#/components/schemas/SearchIndexResponse"
                type: array
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
        '503':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/ApiError"
          description: Service Unavailable.
      summary: Return All Atlas Search Indexes for One Cluster
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch listClusterSearchIndexes --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterSearchIndexesApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tListGroupClusterSearchIndexesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true"
      x-rolesRequirements:
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Search Index Editor
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterSearchIndexes
      x-xgen-operation-id-override: listClusterSearchIndexes
    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 Service Account
        or API Key must have the Project Data Access Admin role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: createGroupClusterSearchIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/SearchIndexCreateRequest"
        description: Creates one Atlas Search index on the specified collection.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/SearchIndexResponse"
              x-xgen-version: '2024-05-30'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Atlas Search Index
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch createClusterSearchIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterSearchIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tCreateGroupClusterSearchIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Search Index Editor
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createGroupClusterSearchIndex
      x-xgen-operation-id-override: createClusterSearchIndex
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/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 Service Account or API Key
        must have the Project Data Access Read Write role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: listGroupClusterSearchIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Name of the collection that contains one or more Atlas Search
          indexes.
        in: path
        name: collectionName
        required: true
        schema:
          type: string
      - description: 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.2024-05-30+json:
              schema:
                description: List of Atlas Search indexes that MongoDB Cloud returns
                  for this request.
                items:
                  "$ref": "#/components/schemas/SearchIndexResponse"
                type: array
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
        '503':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/ApiError"
          description: Service Unavailable.
      summary: Return All Atlas Search Indexes for One Collection
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch listSearchIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterSearchIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tListGroupClusterSearchIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true"
      x-rolesRequirements:
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Search Index Editor
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listGroupClusterSearchIndex
      x-xgen-method-verb-override:
        customMethod: false
        verb: list
      x-xgen-operation-id-override: listSearchIndex
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}":
    delete:
      description: Removes one Atlas Search index that you identified with its database,
        collection, and name. To use this resource, the requesting Service Account
        or API Key must have the Project Data Access Admin role. This deletion is
        eventually consistent.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: deleteGroupClusterSearchIndexByName
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Name of the collection that contains one or more Atlas Search
          indexes.
        in: path
        name: collectionName
        required: true
        schema:
          type: string
      - description: 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
      - description: Name of the Atlas Search index to delete.
        in: path
        name: indexName
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Atlas Search Index by Name
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch deleteIndexByName --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterSearchIndexByNameApiParams{}\n\thttpResp,
          err := client.AtlasSearchApi.\n\t\tDeleteGroupClusterSearchIndexByNameWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}"
      x-rolesRequirements:
      - Project Search Index Editor
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchIndexByName
      x-xgen-method-verb-override:
        customMethod: true
        verb: deleteByName
      x-xgen-operation-id-override: deleteIndexByName
    get:
      description: Returns one Atlas Search index in the specified project. You identify
        this index using its database, collection and name. Atlas Search index contains
        the indexed fields and the analyzers used to create the index. To use this
        resource, the requesting Service Account or API Key must have the Project
        Data Access Read Write role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: getGroupClusterSearchIndexByName
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Name of the collection that contains one or more Atlas Search
          indexes.
        in: path
        name: collectionName
        required: true
        schema:
          type: string
      - description: 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
      - description: Name of the Atlas Search index to return.
        in: path
        name: indexName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/SearchIndexResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Atlas Search Index by Name
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch getIndexByName --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterSearchIndexByNameApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tGetGroupClusterSearchIndexByNameWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true"
      x-rolesRequirements:
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Search Index Editor
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchIndexByName
      x-xgen-method-verb-override:
        customMethod: true
        verb: getByName
      x-xgen-operation-id-override: getIndexByName
    patch:
      description: Updates one Atlas Search index that you identified with its database,
        collection name, and index name. 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 Service Account or API Key must have
        the Project Data Access Admin role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: updateGroupClusterSearchIndexByName
      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 you want to update.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Name of the collection that contains one or more Atlas Search
          indexes.
        in: path
        name: collectionName
        required: true
        schema:
          type: string
      - description: 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
      - description: Name of the Atlas Search index to update.
        in: path
        name: indexName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/SearchIndexUpdateRequest"
        description: Details to update the Atlas Search index with.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/SearchIndexResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Atlas Search Index by Name
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch updateIndexByName --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterSearchIndexByNameApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tUpdateGroupClusterSearchIndexByNameWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Search Index Editor
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchIndexByName
      x-xgen-method-verb-override:
        customMethod: true
        verb: updateByName
      x-xgen-operation-id-override: updateIndexByName
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}":
    delete:
      description: Removes one Atlas Search index that you identified with its unique
        ID. To use this resource, the requesting Service Account or API Key must have
        the Project Data Access Admin role. This deletion is eventually consistent.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: deleteGroupClusterSearchIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Atlas Search Index by ID
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch deleteClusterSearchIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterSearchIndexApiParams{}\n\thttpResp,
          err := client.AtlasSearchApi.\n\t\tDeleteGroupClusterSearchIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}"
      x-rolesRequirements:
      - Project Search Index Editor
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteGroupClusterSearchIndex
      x-xgen-operation-id-override: deleteClusterSearchIndex
    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
        Service Account or API Key must have the Project Data Access Read Write role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: getGroupClusterSearchIndex
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the Application
          Search [index](https://dochub.mongodb.org/core/index-definitions-fts). 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/SearchIndexResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
        '503':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/ApiError"
          description: Service Unavailable.
      summary: Return One Atlas Search Index by ID
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch getClusterSearchIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterSearchIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tGetGroupClusterSearchIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true"
      x-rolesRequirements:
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Search Index Editor
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getGroupClusterSearchIndex
      x-xgen-operation-id-override: getClusterSearchIndex
    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
        Service Account or API Key must have the Project Data Access Admin role.
      externalDocs:
        description: Atlas Search Indexes
        url: https://dochub.mongodb.org/core/index-definitions-fts
      operationId: updateGroupClusterSearchIndex
      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 you want to update.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the Atlas
          Search [index](https://dochub.mongodb.org/core/index-definitions-fts). 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/SearchIndexUpdateRequest"
        description: Details to update on the Atlas Search index.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/SearchIndexResponse"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Atlas Search Index by ID
      tags:
      - Atlas Search
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api atlasSearch updateClusterSearchIndex --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterSearchIndexApiParams{}\n\tsdkResp,
          httpResp, err := client.AtlasSearchApi.\n\t\tUpdateGroupClusterSearchIndexWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Search Index Editor
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateGroupClusterSearchIndex
      x-xgen-operation-id-override: updateClusterSearchIndex
  "/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 Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: getGroupClusterSnapshotSchedule
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Snapshot Schedule
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup getClusterSnapshotSchedule --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterSnapshotScheduleApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tGetGroupClusterSnapshotScheduleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterSnapshotSchedule
      x-xgen-operation-id-override: getClusterSnapshotSchedule
    patch:
      deprecated: true
      description: |-
        Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: updateGroupClusterSnapshotSchedule
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Snapshot Schedule for One Cluster
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup updateClusterSnapshotSchedule --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterSnapshotScheduleApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tUpdateGroupClusterSnapshotScheduleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateGroupClusterSnapshotSchedule
      x-xgen-operation-id-override: updateClusterSnapshotSchedule
  "/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 Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: listGroupClusterSnapshots
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - 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:
          default: 'true'
          enum:
          - all
          - 'true'
          - 'false'
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedSnapshotView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Legacy Backup Snapshots
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup listClusterSnapshots --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterSnapshotsApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tListGroupClusterSnapshotsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listGroupClusterSnapshots
      x-xgen-operation-id-override: listClusterSnapshots
  "/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 Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: deleteGroupClusterSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Legacy Backup Snapshot
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup deleteClusterSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterSnapshotApiParams{}\n\thttpResp,
          err := client.LegacyBackupApi.\n\t\tDeleteGroupClusterSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteGroupClusterSnapshot
      x-xgen-operation-id-override: deleteClusterSnapshot
    get:
      deprecated: true
      description: Returns one legacy backup snapshot for one cluster in the specified
        project. To use this resource, the requesting Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: getGroupClusterSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/BackupSnapshot"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Legacy Backup Snapshot
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup getClusterSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterSnapshotApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tGetGroupClusterSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getGroupClusterSnapshot
      x-xgen-operation-id-override: getClusterSnapshot
    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
        Service Account or 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.
      externalDocs:
        description: Cloud Backup Documentation
        url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule
      operationId: updateGroupClusterSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Expiration Date for One Legacy Backup Snapshot
      tags:
      - Legacy Backup
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api legacyBackup updateClusterSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterSnapshotApiParams{}\n\tsdkResp,
          httpResp, err := client.LegacyBackupApi.\n\t\tUpdateGroupClusterSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateGroupClusterSnapshot
      x-xgen-operation-id-override: updateClusterSnapshot
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status":
    get:
      description: Returns the status of all changes that you made to the specified
        cluster in the specified project. Use this resource to check the progress
        MongoDB Cloud has made in processing your changes. The response does not include
        the deployment of new dedicated clusters. To use this resource, the requesting
        Service Account or API Key must have the Project Read Only role.
      operationId: getGroupClusterStatus
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ClusterStatus"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Status of All Cluster Operations
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters getClusterStatus --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterStatusApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tGetGroupClusterStatusWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupClusterStatus
      x-xgen-operation-id-override: getClusterStatus
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{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: getGroupClusterCollStatNamespaces
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster to pin namespaces
          to.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Human-readable label that identifies the cluster topology to
          retrieve metrics for.
        in: path
        name: clusterView
        required: true
        schema:
          enum:
          - PRIMARY
          - SECONDARY
          - INDIVIDUAL_PROCESS
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Ranked Namespaces from One Cluster
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics getClusterNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterCollStatNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tGetGroupClusterCollStatNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getGroupClusterCollStatNamespaces
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getClusterNamespaces
  "/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: listGroupClusterCollStatMeasurements
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster to retrieve
          metrics for.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Human-readable label that identifies the cluster topology to
          retrieve metrics for.
        in: path
        name: clusterView
        required: true
        schema:
          enum:
          - PRIMARY
          - SECONDARY
          - INDIVIDUAL_PROCESS
          type: string
      - "$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.
        explode: true
        in: query
        name: metrics
        schema:
          items:
            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
            type: string
          type: array
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Cluster-Level Query Latency
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics listCollStatMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterCollStatMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tListGroupClusterCollStatMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupClusterCollStatMeasurements
      x-xgen-operation-id-override: listCollStatMeasurements
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess":
    post:
      description: Grants MongoDB employee cluster access for the given duration and
        at the specified level for one cluster. To use this resource, the requesting
        Service Account or API Key must have the Project Owner role or Project Support
        Access Manager role.
      operationId: grantGroupClusterMongoDbEmployeeAccess
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/EmployeeAccessGrantView"
            x-xgen-version: '2024-08-05'
        description: Grant access level and expiration.
        required: true
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Grant MongoDB Employee Cluster Access for One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters grantMongoEmployeeAccess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GrantGroupClusterMongoDbEmployeeAccessApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tGrantGroupClusterMongoDbEmployeeAccessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Support Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantGroupClusterMongoDbEmployeeAccess
      x-xgen-operation-id-override: grantMongoEmployeeAccess
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion":
    post:
      description: Pins the Feature Compatibility Version (FCV) to the current MongoDB
        version and sets the pin expiration date. If an FCV pin already exists for
        the cluster, calling this method will only update the expiration date of the
        existing pin and will not re-pin the FCV.
      operationId: pinGroupClusterFeatureCompatibilityVersion
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/PinFCVView"
            x-xgen-version: '2024-05-30'
        description: Optional request parameters for tuning FCV pinning configuration.
      responses:
        '204':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Pin Feature Compatibility Version for One Cluster in One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters pinFeatureCompatibilityVersion --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.PinGroupClusterFeatureCompatibilityVersionApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tPinGroupClusterFeatureCompatibilityVersionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinGroupClusterFeatureCompatibilityVersion
      x-xgen-operation-id-override: pinFeatureCompatibilityVersion
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess":
    post:
      description: Revokes a previously granted MongoDB employee cluster access. To
        use this resource, the requesting Service Account or API Key must have the
        Project Owner role or Project Support Access Manager role.
      operationId: revokeGroupClusterMongoDbEmployeeAccess
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Revoke MongoDB Employee Cluster Access for One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters revokeMongoEmployeeAccess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RevokeGroupClusterMongoDbEmployeeAccessApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tRevokeGroupClusterMongoDbEmployeeAccessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Support Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeGroupClusterMongoDbEmployeeAccess
      x-xgen-operation-id-override: revokeMongoEmployeeAccess
  "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion":
    post:
      description: Unpins the current fixed Feature Compatibility Version (FCV). This
        feature is not available for clusters on rapid release.
      operationId: unpinGroupClusterFeatureCompatibilityVersion
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies this cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Unpin Feature Compatibility Version for One Cluster in One Project
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters unpinFeatureCompatibilityVersion --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UnpinGroupClusterFeatureCompatibilityVersionApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tUnpinGroupClusterFeatureCompatibilityVersionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinGroupClusterFeatureCompatibilityVersion
      x-xgen-operation-id-override: unpinFeatureCompatibilityVersion
  "/api/atlas/v2/groups/{groupId}/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. Logs are stored in chunks approximately five minutes in length, but
        this duration may vary. If you poll the API for log files, we recommend polling
        every five minutes even though consecutive polls could contain some overlapping
        logs. This feature isn''t available for `M0` free clusters, `M2`, `M5`, flex,
        or serverless clusters. To use this resource, the requesting Service Account
        or API Key must have the Project Cluster Log Viewer role or Project Data Access
        Read Only role. The API does not support direct calls with the json response
        schema. You must request a gzip response schema using an accept header of
        the format: `Accept: application/vnd.atlas.YYYY-MM-DD+gzip`. Deprecated versions:
        v2-{2023-01-01}'
      operationId: downloadGroupClusterLog
      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:
          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]+)?$"
          type: string
      - 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:
          enum:
          - mongodb
          - mongos
          - mongodb-audit-log
          - mongos-audit-log
          externalDocs:
            description: Set up Database Auditing
            url: https://docs.atlas.mongodb.com/database-auditing/
          type: string
      - description: Specifies the date and time for the ending point of the range
          of log messages to retrieve, in the number of seconds that have elapsed
          since the UNIX epoch. This value will default to 24 hours after the start
          date. If the start date is also unspecified, the value will default to the
          time of the request.
        in: query
        name: endDate
        schema:
          format: int64
          minimum: 1199145600
          type: integer
      - description: Specifies the date and time for the starting point of the range
          of log messages to retrieve, in the number of seconds that have elapsed
          since the UNIX epoch. This value will default to 24 hours prior to the end
          date. If the end date is also unspecified, the value will default to 24
          hours prior to the time of the request.
        in: query
        name: startDate
        schema:
          format: int64
          minimum: 1199145600
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2023-02-01+gzip:
              schema:
                description: Compressed (.gz) log file that contains a range of log
                  messages for the specified host for the specified project
                format: binary
                type: string
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Download Logs for One Cluster Host in One Project
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs downloadClusterLog --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DownloadGroupClusterLogApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tDownloadGroupClusterLogWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
            --output "file_name.gz"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
            --output "file_name.gz"
      x-rolesRequirements:
      - Project Cluster Log Viewer
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/downloadGroupClusterLog
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: download
      x-xgen-operation-id-override: downloadClusterLog
  "/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: listGroupCollStatMetrics
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-11-15+json:
              x-xgen-version: '2023-11-15'
          description: Succeeded
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Metric Names
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics listCollStatMetrics --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupCollStatMetricsApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tListGroupCollStatMetricsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupCollStatMetrics
      x-xgen-operation-id-override: listCollStatMetrics
  "/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
        Service Account or API Key must have the Project Read Only role.
      operationId: listGroupContainers
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedCloudProviderContainerView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Network Peering Containers in One Project for One Cloud
        Provider
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering listGroupContainers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupContainersApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tListGroupContainersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupContainers
    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
        Service Account or API Key must have the Project Owner role.
      operationId: createGroupContainer
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Network Peering Container
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering createGroupContainer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupContainerApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tCreateGroupContainerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createGroupContainer
  "/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 Service Account or API Key must have the
        Project Read Only role.
      operationId: listGroupContainerAll
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Network Peering Containers in One Project
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering listGroupContainerAll --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupContainerAllApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tListGroupContainerAllWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupContainerAll
      x-xgen-method-verb-override:
        customMethod: 'False'
        verb: list
  "/api/atlas/v2/groups/{groupId}/containers/{containerId}":
    delete:
      description: Removes one network peering container in the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role.
      operationId: deleteGroupContainer
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Network Peering Container
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering deleteGroupContainer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupContainerApiParams{}\n\thttpResp,
          err := client.NetworkPeeringApi.\n\t\tDeleteGroupContainerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deleteGroupContainer
    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 Service Account or API Key must have the
        Project Read Only role.
      operationId: getGroupContainer
      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.
        in: path
        name: containerId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/CloudProviderContainer"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Network Peering Container
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering getGroupContainer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupContainerApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tGetGroupContainerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getGroupContainer
    patch:
      description: Updates the network details and labels of one specified network
        peering container in the specified project. To use this resource, the requesting
        Service Account or API Key must have the Project Owner role.
      operationId: updateGroupContainer
      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:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Network Peering Container
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering updateGroupContainer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupContainerApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tUpdateGroupContainerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updateGroupContainer
  "/api/atlas/v2/groups/{groupId}/customDBRoles/roles":
    get:
      description: Returns all custom roles for the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Read Only role.
      operationId: listGroupCustomDbRoleRoles
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/UserCustomDBRole"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Custom Roles in One Project
      tags:
      - Custom Database Roles
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api customDatabaseRoles listCustomDbRoles --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupCustomDbRoleRolesApiParams{}\n\tsdkResp,
          httpResp, err := client.CustomDatabaseRolesApi.\n\t\tListGroupCustomDbRoleRolesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listGroupCustomDbRoleRoles
      x-xgen-operation-id-override: listCustomDbRoles
    post:
      description: Creates one custom role in the specified project. To use this resource,
        the requesting Service Account or API Key must have the Project Owner role,
        Project Stream Processing Owner role, or the Project Database Access Admin
        role.
      operationId: createGroupCustomDbRoleRole
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Custom Role
      tags:
      - Custom Database Roles
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api customDatabaseRoles createCustomDbRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupCustomDbRoleRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.CustomDatabaseRolesApi.\n\t\tCreateGroupCustomDbRoleRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Database Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createGroupCustomDbRoleRole
      x-xgen-operation-id-override: createCustomDbRole
  "/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 Service
        Account or API Key must have the Project Owner role, Project Stream Processing
        Owner role, or the Project Database Access Admin role.
      operationId: deleteGroupCustomDbRoleRole
      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
      responses:
        '204':
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: '2023-01-01'
          description: No Content
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Custom Role from One Project
      tags:
      - Custom Database Roles
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api customDatabaseRoles deleteCustomDbRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupCustomDbRoleRoleApiParams{}\n\thttpResp,
          err := client.CustomDatabaseRolesApi.\n\t\tDeleteGroupCustomDbRoleRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}"
      x-rolesRequirements:
      - Project Database Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteGroupCustomDbRoleRole
      x-xgen-operation-id-override: deleteCustomDbRole
    get:
      description: Returns one custom role for the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Read Only role.
      operationId: getGroupCustomDbRoleRole
      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
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/UserCustomDBRole"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Custom Role in One Project
      tags:
      - Custom Database Roles
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api customDatabaseRoles getCustomDbRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupCustomDbRoleRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.CustomDatabaseRolesApi.\n\t\tGetGroupCustomDbRoleRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getGroupCustomDbRoleRole
      x-xgen-operation-id-override: getCustomDbRole
    patch:
      description: Updates one custom role in the specified project. To use this resource,
        the requesting Service Account or API Key must have the Project Owner role,
        the Project Stream Processing Owner role, or the Project Database Access Admin
        role.
      operationId: updateGroupCustomDbRoleRole
      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
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Custom Role in One Project
      tags:
      - Custom Database Roles
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api customDatabaseRoles updateCustomDbRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupCustomDbRoleRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.CustomDatabaseRolesApi.\n\t\tUpdateGroupCustomDbRoleRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Database Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateGroupCustomDbRoleRole
      x-xgen-operation-id-override: updateCustomDbRole
  "/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 Service Account or
        API Key must have the Project Read Only or higher role.
      operationId: listGroupDataFederation
      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:
          default: USER
          enum:
          - USER
          - ONLINE_ARCHIVE
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/DataLakeTenant"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Federated Database Instances in One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation listDataFederation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupDataFederationApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tListGroupDataFederationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupDataFederation
      x-xgen-operation-id-override: listDataFederation
    post:
      description: Creates one federated database instance in the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner or Project Charts Admin roles.
      operationId: createGroupDataFederation
      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:
          default: false
          type: boolean
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Federated Database Instance in One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation createDataFederation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupDataFederationApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tCreateGroupDataFederationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createGroupDataFederation
      x-xgen-operation-id-override: createDataFederation
  "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}":
    delete:
      description: Removes one federated database instance from the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner or Project Charts Admin roles.
      operationId: deleteGroupDataFederation
      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:
              x-xgen-version: '2023-01-01'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Federated Database Instance from One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation deleteDataFederation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupDataFederationApiParams{}\n\thttpResp,
          err := client.DataFederationApi.\n\t\tDeleteGroupDataFederationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupDataFederation
      x-xgen-operation-id-override: deleteDataFederation
    get:
      description: Returns the details of one federated database instance within the
        specified project. To use this resource, the requesting Service Account or
        API Key must have the Project Read Only or Project Charts Admin roles.
      operationId: getGroupDataFederation
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Federated Database Instance in One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation getDataFederation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupDataFederationApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tGetGroupDataFederationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupDataFederation
      x-xgen-operation-id-override: getDataFederation
    patch:
      description: Updates the details of one federated database instance in the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Owner or higher role.
      operationId: updateGroupDataFederation
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Federated Database Instance in One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation updateDataFederation --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupDataFederationApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tUpdateGroupDataFederationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateGroupDataFederation
      x-xgen-operation-id-override: updateDataFederation
  "/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 Service Account or
        API Key must have the Project Read Only role.
      operationId: listGroupDataFederationLimits
      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:
                items:
                  "$ref": "#/components/schemas/DataFederationTenantQueryLimit"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Query Limits for One Federated Database Instance
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation listDataFederationLimits --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupDataFederationLimitsApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tListGroupDataFederationLimitsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupDataFederationLimits
      x-xgen-operation-id-override: listDataFederationLimits
  "/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 Service Account or API Key must have the
        Project Owner role.
      operationId: deleteGroupDataFederationLimit
      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:
          enum:
          - bytesProcessed.query
          - bytesProcessed.daily
          - bytesProcessed.weekly
          - bytesProcessed.monthly
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Query Limit for One Federated Database Instance
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation deleteDataFederationLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupDataFederationLimitApiParams{}\n\thttpResp,
          err := client.DataFederationApi.\n\t\tDeleteGroupDataFederationLimitWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupDataFederationLimit
      x-xgen-operation-id-override: deleteDataFederationLimit
    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
        Service Account or API Key must have the Project Read Only role.
      operationId: getGroupDataFederationLimit
      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:
          enum:
          - bytesProcessed.query
          - bytesProcessed.daily
          - bytesProcessed.weekly
          - bytesProcessed.monthly
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DataFederationTenantQueryLimit"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Federated Database Instance Query Limit for One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation getDataFederationLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupDataFederationLimitApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tGetGroupDataFederationLimitWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupDataFederationLimit
      x-xgen-operation-id-override: getDataFederationLimit
    patch:
      description: Creates or updates one query limit for one federated database instance.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role.
      operationId: setGroupDataFederationLimit
      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:
          enum:
          - bytesProcessed.query
          - bytesProcessed.daily
          - bytesProcessed.weekly
          - bytesProcessed.monthly
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Configure One Query Limit for One Federated Database Instance
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation setDataFederationLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.SetGroupDataFederationLimitApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tSetGroupDataFederationLimitWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/setGroupDataFederationLimit
      x-xgen-method-verb-override:
        customMethod: true
        verb: set
      x-xgen-operation-id-override: setDataFederationLimit
  "/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 Service Account or API Key
        must have the Project Owner or Project Data Access Read Write roles. The API
        does not support direct calls with the json response schema. You must request
        a gzip response schema using an accept header of the format: `Accept: application/vnd.atlas.YYYY-MM-DD+gzip`.'
      operationId: downloadGroupDataFederationQueryLogs
      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:
          example: 1636481348
          format: int64
          pattern: '1199145600'
          type: integer
      - 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:
          example: 1636466948
          format: int64
          pattern: '1199145600'
          type: integer
      - 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:
                description: Compressed archive labeled `queryLogs.gz` downloads
                format: binary
                type: string
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Download Query Logs for One Federated Database Instance
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation downloadFederationQueryLogs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DownloadGroupDataFederationQueryLogsApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tDownloadGroupDataFederationQueryLogsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz" \
            --output "file_name.gz"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz" \
            --output "file_name.gz"
      x-rolesRequirements:
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadGroupDataFederationQueryLogs
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: download
      x-xgen-operation-id-override: downloadFederationQueryLogs
  "/api/atlas/v2/groups/{groupId}/databaseUsers":
    get:
      description: Returns all database users that belong to the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: listGroupDatabaseUsers
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Database Users in One Project
      tags:
      - Database Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api databaseUsers listDatabaseUsers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupDatabaseUsersApiParams{}\n\tsdkResp,
          httpResp, err := client.DatabaseUsersApi.\n\t\tListGroupDatabaseUsersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listGroupDatabaseUsers
      x-xgen-operation-id-override: listDatabaseUsers
    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. To use this resource,
        the requesting Service Account or API Key must have the Project Owner role,
        the Project Charts Admin role, Project Stream Processing Owner role, or the
        Project Database Access Admin role.
      externalDocs:
        description: Contact MongoDB Support
        url: https://cloud.mongodb.com/support
      operationId: createGroupDatabaseUser
      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
              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
              OIDC Workforce Federated Authentication:
                description: OIDC Workforce 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
              OIDC Workload Federated Authentication:
                description: OIDC Workload Federated Authentication
                value:
                  databaseName: "$external"
                  groupId: 32b6e34b3d91647abb20e7b8
                  oidcAuthType: USER
                  roles:
                  - databaseName: sales
                    roleName: readWrite
                  - databaseName: marketing
                    roleName: read
                  scopes:
                  - name: myCluster
                    type: CLUSTER
                  username: 5dd7496c7a3e5a648454341c/sales
              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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Database User in One Project
      tags:
      - Database Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api databaseUsers createDatabaseUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupDatabaseUserApiParams{}\n\tsdkResp,
          httpResp, err := client.DatabaseUsersApi.\n\t\tCreateGroupDatabaseUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Database Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createGroupDatabaseUser
      x-xgen-operation-id-override: createDatabaseUser
  "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}":
    delete:
      description: Removes one database user from the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Owner role, the Project Stream Processing Owner role, or the Project Database
        Access Admin role.
      operationId: deleteGroupDatabaseUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: 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, LDAP, or OIDC Workload
          this value should be `$external`. If the user authenticates with SCRAM-SHA
          or OIDC Workforce, 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 | `awsIAMType` | `ROLE` | <abbr title="Amazon Resource Name">ARN</abbr> |
          | AWS IAM | `awsIAMType` | `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 Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
          | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |
          | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |
        in: path
        name: username
        required: true
        schema:
          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'
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Database User from One Project
      tags:
      - Database Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api databaseUsers deleteDatabaseUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupDatabaseUserApiParams{}\n\thttpResp,
          err := client.DatabaseUsersApi.\n\t\tDeleteGroupDatabaseUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}"
      x-rolesRequirements:
      - Project Database Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteGroupDatabaseUser
      x-xgen-operation-id-override: deleteDatabaseUser
    get:
      description: Returns one database user that belong to the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: getGroupDatabaseUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: 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, LDAP, or OIDC Workload
          this value should be `$external`. If the user authenticates with SCRAM-SHA
          or OIDC Workforce, 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 | `awsIAMType` | `ROLE` | <abbr title="Amazon Resource Name">ARN</abbr> |
          | AWS IAM | `awsIAMType` | `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 Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
          | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |
          | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |
        in: path
        name: username
        required: true
        schema:
          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'
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/CloudDatabaseUser"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Database User from One Project
      tags:
      - Database Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api databaseUsers getDatabaseUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupDatabaseUserApiParams{}\n\tsdkResp,
          httpResp, err := client.DatabaseUsersApi.\n\t\tGetGroupDatabaseUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getGroupDatabaseUser
      x-xgen-operation-id-override: getDatabaseUser
    patch:
      description: Updates one database user that belongs to the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role, Project Charts Admin role, Project Stream Processing
        Owner role, or the Project Database Access Admin role.
      operationId: updateGroupDatabaseUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: 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, LDAP, or OIDC Workload
          this value should be `$external`. If the user authenticates with SCRAM-SHA
          or OIDC Workforce, 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 | `awsIAMType` | `ROLE` | <abbr title="Amazon Resource Name">ARN</abbr> |
          | AWS IAM | `awsIAMType` | `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 Workforce | `oidcAuthType` | `IDP_GROUP` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
          | OIDC Workload | `oidcAuthType` | `USER` | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |
          | SCRAM-SHA | `awsIAMType`, `x509Type`, `ldapAuthType`, `oidcAuthType` | `NONE` | Alphanumeric string |
        in: path
        name: username
        required: true
        schema:
          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'
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Database User in One Project
      tags:
      - Database Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api databaseUsers updateDatabaseUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupDatabaseUserApiParams{}\n\tsdkResp,
          httpResp, err := client.DatabaseUsersApi.\n\t\tUpdateGroupDatabaseUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Database Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateGroupDatabaseUser
      x-xgen-operation-id-override: updateDatabaseUser
  "/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 Service Account
        or API Key must have the Project Read Only role.
      operationId: listGroupDatabaseUserCerts
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All X.509 Certificates Assigned to One Database User
      tags:
      - X.509 Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api x509Authentication listDatabaseUserCerts --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupDatabaseUserCertsApiParams{}\n\tsdkResp,
          httpResp, err := client.X509AuthenticationApi.\n\t\tListGroupDatabaseUserCertsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listGroupDatabaseUserCerts
      x-xgen-operation-id-override: listDatabaseUserCerts
    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 Service Account or 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: createGroupDatabaseUserCert
      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:
                description: PEM file that contains the user's X.509 certificate and
                  private key.
                type: string
              x-xgen-version: '2023-01-01'
          description: This endpoint returns a PEM file with the certificate and private
            key.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One X.509 Certificate for One Database User
      tags:
      - X.509 Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api x509Authentication createDatabaseUserCert --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupDatabaseUserCertApiParams{}\n\tsdkResp,
          httpResp, err := client.X509AuthenticationApi.\n\t\tCreateGroupDatabaseUserCertWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createGroupDatabaseUserCert
      x-xgen-operation-id-override: createDatabaseUserCert
  "/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 Service Account or API Key must have
        the Project Monitoring Admin role, the Project Database Access Admin role,
        or the Project Cluster Log Viewer role.
      externalDocs:
        description: Database Access History
        url: https://docs.atlas.mongodb.com/access-tracking/
      operationId: getGroupDbAccessHistoryCluster
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - 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:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: One Internet Protocol address that attempted to authenticate
          with the database.
        in: query
        name: ipAddress
        schema:
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
      - description: Maximum number of lines from the log to return.
        in: query
        name: nLogs
        schema:
          default: 20000
          format: int32
          maximum: 20000
          minimum: 0
          type: integer
      - 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:
          format: int64
          minimum: 1199145600000
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/MongoDBAccessLogsList"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Database Access History for One Cluster by Cluster Name
      tags:
      - Access Tracking
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api accessTracking getAccessHistoryCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupDbAccessHistoryClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.AccessTrackingApi.\n\t\tGetGroupDbAccessHistoryClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
      x-rolesRequirements:
      - Project Cluster Log Viewer
      - Project Database Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/getGroupDbAccessHistoryCluster
      x-xgen-operation-id-override: getAccessHistoryCluster
  "/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 Service Account or API Key must
        have the Project Monitoring Admin role, the Project Database Access Admin
        role, or the Project Cluster Log Viewer role.
      externalDocs:
        description: Database Access History
        url: https://docs.atlas.mongodb.com/access-tracking/
      operationId: getGroupDbAccessHistoryProcess
      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:
          format: int64
          minimum: 1199145600000
          type: integer
      - 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:
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
      - description: Maximum number of lines from the log to return.
        in: query
        name: nLogs
        schema:
          default: 20000
          format: int32
          maximum: 20000
          minimum: 0
          type: integer
      - 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:
          format: int64
          minimum: 1199145600000
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/MongoDBAccessLogsList"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Database Access History for One Cluster by Hostname
      tags:
      - Access Tracking
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api accessTracking getAccessHistoryProcess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupDbAccessHistoryProcessApiParams{}\n\tsdkResp,
          httpResp, err := client.AccessTrackingApi.\n\t\tGetGroupDbAccessHistoryProcessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true"
      x-rolesRequirements:
      - Project Cluster Log Viewer
      - Project Database Access Admin
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/getGroupDbAccessHistoryProcess
      x-xgen-operation-id-override: getAccessHistoryProcess
  "/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 Service Account or 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: getGroupEncryptionAtRest
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Configuration for Encryption at Rest Using Customer-Managed
        Keys for One Project
      tags:
      - Encryption at Rest using Customer Key Management
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupEncryptionAtRestApiParams{}\n\tsdkResp,
          httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.\n\t\tGetGroupEncryptionAtRestWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getGroupEncryptionAtRest
      x-xgen-operation-id-override: getEncryptionAtRest
    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 Service Account or 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: updateGroupEncryptionAtRest
      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 For authentication, you must provide either `serviceAccountKey` (static credentials) or `roleId` (service-account–based authentication) Once `roleId` is configured, `serviceAccountKey` is no longer supported.

          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Encryption at Rest Configuration in One Project
      tags:
      - Encryption at Rest using Customer Key Management
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupEncryptionAtRestApiParams{}\n\tsdkResp,
          httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.\n\t\tUpdateGroupEncryptionAtRestWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateGroupEncryptionAtRest
      x-xgen-operation-id-override: updateEncryptionAtRest
  "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints":
    get:
      description: Returns the private endpoints of the specified cloud provider for
        encryption at rest using customer key management.
      operationId: listGroupEncryptionAtRestPrivateEndpoints
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - description: Human-readable label that identifies the cloud provider for the
          private endpoints to return.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AZURE
          - AWS
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasEARPrivateEndpointView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Private Endpoints for Encryption at Rest Using Customer Key
        Management for One Cloud Provider in One Project
      tags:
      - Encryption at Rest using Customer Key Management
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api encryptionAtRestUsingCustomerKeyManagement listRestPrivateEndpoints
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupEncryptionAtRestPrivateEndpointsApiParams{}\n\tsdkResp,
          httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.\n\t\tListGroupEncryptionAtRestPrivateEndpointsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/listGroupEncryptionAtRestPrivateEndpoints
      x-xgen-operation-id-override: listRestPrivateEndpoints
    post:
      description: Creates a private endpoint in the specified region for encryption
        at rest using customer key management.
      operationId: createGroupEncryptionAtRestPrivateEndpoint
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cloud provider for the
          private endpoint to create.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AZURE
          - AWS
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              "$ref": "#/components/schemas/EARPrivateEndpoint"
        description: Creates a private endpoint in the specified region.
        required: true
      responses:
        '202':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/EARPrivateEndpoint"
              x-xgen-version: '2023-01-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Private Endpoint for Encryption at Rest Using Customer Key
        Management for One Cloud Provider in One Project
      tags:
      - Encryption at Rest using Customer Key Management
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api encryptionAtRestUsingCustomerKeyManagement createRestPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupEncryptionAtRestPrivateEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.\n\t\tCreateGroupEncryptionAtRestPrivateEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createGroupEncryptionAtRestPrivateEndpoint
      x-xgen-operation-id-override: createRestPrivateEndpoint
  "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}":
    delete:
      description: Deletes one private endpoint, identified by its ID, for encryption
        at rest using Customer Key Management.
      operationId: requestGroupEncryptionAtRestPrivateEndpointDeletion
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cloud provider of the
          private endpoint to delete.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AZURE
          - AWS
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint to delete.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Private Endpoint for Encryption at Rest Using Customer Key
        Management for One Cloud Provider from One Project
      tags:
      - Encryption at Rest using Customer Key Management
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api encryptionAtRestUsingCustomerKeyManagement requestPrivateEndpointDeletion
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RequestGroupEncryptionAtRestPrivateEndpointDeletionApiParams{}\n\thttpResp,
          err := client.EncryptionatRestusingCustomerKeyManagementApi.\n\t\tRequestGroupEncryptionAtRestPrivateEndpointDeletionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestGroupEncryptionAtRestPrivateEndpointDeletion
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: requestDeletion
      x-xgen-operation-id-override: requestPrivateEndpointDeletion
    get:
      description: Returns one private endpoint, identified by its ID, for encryption
        at rest using Customer Key Management.
      operationId: getGroupEncryptionAtRestPrivateEndpoint
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cloud provider of the
          private endpoint.
        in: path
        name: cloudProvider
        required: true
        schema:
          enum:
          - AZURE
          - AWS
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/EARPrivateEndpoint"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Private Endpoint for Encryption at Rest Using Customer Key
        Management for One Cloud Provider in One Project
      tags:
      - Encryption at Rest using Customer Key Management
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api encryptionAtRestUsingCustomerKeyManagement getRestPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupEncryptionAtRestPrivateEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.\n\t\tGetGroupEncryptionAtRestPrivateEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getGroupEncryptionAtRestPrivateEndpoint
      x-xgen-operation-id-override: getRestPrivateEndpoint
  "/api/atlas/v2/groups/{groupId}/events":
    get:
      description: |-
        Returns events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        This resource remains under revision and may change.
      operationId: listGroupEvents
      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:
          items:
            pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
            type: string
          type: array
        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:
          items:
            "$ref": "#/components/schemas/EventTypeForNdsGroup"
          type: array
      - 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:
          items:
            "$ref": "#/components/schemas/EventTypeForNdsGroup"
          type: array
      - 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:
          default: false
          type: boolean
      - description: Date and time from when MongoDB Cloud stops returning events.
          This parameter uses the ISO 8601 timestamp format in UTC.
        in: query
        name: maxDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      - description: Date and time from when MongoDB Cloud starts returning events.
          This parameter uses the ISO 8601 timestamp format in UTC.
        in: query
        name: minDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/GroupPaginatedEventView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Events from One Project
      tags:
      - Events
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api events listGroupEvents --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupEventsApiParams{}\n\tsdkResp,
          httpResp, err := client.EventsApi.\n\t\tListGroupEventsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listGroupEvents
  "/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 Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return Events from One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents
      operationId: getGroupEvent
      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.
        in: path
        name: eventId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/EventViewForNdsGroup"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Event from One Project
      tags:
      - Events
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api events getGroupEvent --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupEventApiParams{}\n\tsdkResp,
          httpResp, err := client.EventsApi.\n\t\tGetGroupEventWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getGroupEvent
  "/api/atlas/v2/groups/{groupId}/flexClusters":
    get:
      description: Returns details for all flex clusters in the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: listGroupFlexClusters
      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.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/PaginatedFlexClusters20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Flex Clusters from One Project
      tags:
      - Flex Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexClusters listFlexClusters --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupFlexClustersApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexClustersApi.\n\t\tListGroupFlexClustersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listGroupFlexClusters
      x-xgen-operation-id-override: listFlexClusters
    post:
      description: Creates one flex cluster in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Owner role.
      operationId: createGroupFlexCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-11-13+json:
            schema:
              "$ref": "#/components/schemas/FlexClusterDescriptionCreate20241113"
        description: Create One Flex Cluster in One Project.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexClusterDescription20241113"
              x-xgen-version: '2024-11-13'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Flex Cluster in One Project
      tags:
      - Flex Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexClusters createFlexCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupFlexClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexClustersApi.\n\t\tCreateGroupFlexClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createGroupFlexCluster
      x-xgen-operation-id-override: createFlexCluster
  "/api/atlas/v2/groups/{groupId}/flexClusters/{name}":
    delete:
      description: Removes one flex cluster from the specified project. The flex cluster
        must have termination protection disabled in order to be deleted. To use this
        resource, the requesting Service Account or API Key must have the Project
        Owner role.
      operationId: deleteGroupFlexCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-11-13+json:
              x-xgen-version: '2024-11-13'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Flex Cluster from One Project
      tags:
      - Flex Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexClusters deleteFlexCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupFlexClusterApiParams{}\n\thttpResp,
          err := client.FlexClustersApi.\n\t\tDeleteGroupFlexClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteGroupFlexCluster
      x-xgen-operation-id-override: deleteFlexCluster
    get:
      description: Returns details for one flex cluster in the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: getGroupFlexCluster
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexClusterDescription20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Flex Cluster from One Project
      tags:
      - Flex Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexClusters getFlexCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupFlexClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexClustersApi.\n\t\tGetGroupFlexClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getGroupFlexCluster
      x-xgen-operation-id-override: getFlexCluster
    patch:
      description: Updates one flex cluster in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Owner role.
      operationId: updateGroupFlexCluster
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-11-13+json:
            schema:
              "$ref": "#/components/schemas/FlexClusterDescriptionUpdate20241113"
        description: Update One Flex Cluster in One Project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexClusterDescription20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
      summary: Update One Flex Cluster in One Project
      tags:
      - Flex Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexClusters updateFlexCluster --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupFlexClusterApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexClustersApi.\n\t\tUpdateGroupFlexClusterWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateGroupFlexCluster
      x-xgen-operation-id-override: updateFlexCluster
  "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download":
    post:
      description: Requests one snapshot for the specified flex 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 Service Account or API Key must have the Project Owner role
        or Project Backup Export Operator role.
      operationId: downloadGroupFlexClusterBackup
      parameters:
      - description: Human-readable label that identifies the flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-11-13+json:
            schema:
              "$ref": "#/components/schemas/FlexBackupSnapshotDownloadCreate20241113"
        description: Snapshot to be downloaded.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexBackupRestoreJob20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Download One Flex Cluster Snapshot
      tags:
      - Flex Snapshots
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexSnapshots downloadFlexBackup --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DownloadGroupFlexClusterBackupApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexSnapshotsApi.\n\t\tDownloadGroupFlexClusterBackupWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Export Operator
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadGroupFlexClusterBackup
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: downloadFlexBackup
  "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs":
    get:
      description: Returns all restore jobs for one flex cluster from the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role.
      operationId: listGroupFlexClusterBackupRestoreJobs
      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 flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasFlexBackupRestoreJob20241113View"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Restore Jobs for One Flex Cluster
      tags:
      - Flex Restore Jobs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexRestoreJobs listFlexRestoreJobs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupFlexClusterBackupRestoreJobsApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexRestoreJobsApi.\n\t\tListGroupFlexClusterBackupRestoreJobsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listGroupFlexClusterBackupRestoreJobs
      x-xgen-operation-id-override: listFlexRestoreJobs
    post:
      description: Restores one snapshot of one flex cluster from the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Backup Recovery Operator role.
      operationId: createGroupFlexClusterBackupRestoreJob
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the flex cluster whose snapshot
          you want to restore.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-11-13+json:
            schema:
              "$ref": "#/components/schemas/FlexBackupRestoreJobCreate20241113"
        description: Restores one snapshot of one flex cluster from the specified
          project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexBackupRestoreJob20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Restore Job for One Flex Cluster
      tags:
      - Flex Restore Jobs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexRestoreJobs createFlexRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupFlexClusterBackupRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexRestoreJobsApi.\n\t\tCreateGroupFlexClusterBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Backup Recovery Operator
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createGroupFlexClusterBackupRestoreJob
      x-xgen-operation-id-override: createFlexRestoreJob
  "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}":
    get:
      description: Returns one restore job for one flex cluster from the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupFlexClusterBackupRestoreJob
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Human-readable label that identifies the flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to return.
        in: path
        name: restoreJobId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexBackupRestoreJob20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Restore Job for One Flex Cluster
      tags:
      - Flex Restore Jobs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexRestoreJobs getFlexRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupFlexClusterBackupRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexRestoreJobsApi.\n\t\tGetGroupFlexClusterBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getGroupFlexClusterBackupRestoreJob
      x-xgen-operation-id-override: getFlexRestoreJob
  "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots":
    get:
      description: Returns all snapshots of one flex cluster from the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: listGroupFlexClusterBackupSnapshots
      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 flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasFlexBackupSnapshot20241113View"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Snapshots for One Flex Cluster
      tags:
      - Flex Snapshots
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexSnapshots listFlexBackupSnapshots --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupFlexClusterBackupSnapshotsApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexSnapshotsApi.\n\t\tListGroupFlexClusterBackupSnapshotsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listGroupFlexClusterBackupSnapshots
      x-xgen-operation-id-override: listFlexBackupSnapshots
  "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}":
    get:
      description: Returns one snapshot of one flex cluster from the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: getGroupFlexClusterBackupSnapshot
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the flex cluster.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexBackupSnapshot20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Snapshot for One Flex Cluster
      tags:
      - Flex Snapshots
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexSnapshots getFlexBackupSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupFlexClusterBackupSnapshotApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexSnapshotsApi.\n\t\tGetGroupFlexClusterBackupSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getGroupFlexClusterBackupSnapshot
      x-xgen-operation-id-override: getFlexBackupSnapshot
  "/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade":
    post:
      description: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Cluster Manager role.
      operationId: tenantGroupFlexClusterUpgrade
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-11-13+json:
            schema:
              "$ref": "#/components/schemas/AtlasTenantClusterUpgradeRequest20240805"
        description: Details of the flex cluster upgrade in the specified project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/FlexClusterDescription20241113"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Upgrade One Flex Cluster
      tags:
      - Flex Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api flexClusters tenantUpgrade --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.TenantGroupFlexClusterUpgradeApiParams{}\n\tsdkResp,
          httpResp, err := client.FlexClustersApi.\n\t\tTenantGroupFlexClusterUpgradeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Cluster Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/tenantGroupFlexClusterUpgrade
      x-xgen-operation-id-override: tenantUpgrade
  "/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: listGroupHostFtsMetrics
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Atlas Search Metric Types for One Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs listHostFtsMetrics --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupHostFtsMetricsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tListGroupHostFtsMetricsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetrics
      x-xgen-operation-id-override: listHostFtsMetrics
  "/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: listGroupHostFtsMetricIndexMeasurements
      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:
          description: List that contains the measurements that MongoDB Atlas reports
            for the associated data series.
          items:
            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
            type: string
          maxItems: 10
          type: array
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Atlas Search Index Metrics for One Namespace
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs listIndexMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupHostFtsMetricIndexMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tListGroupHostFtsMetricIndexMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetricIndexMeasurements
      x-xgen-method-verb-override:
        customMethod: false
        verb: list
      x-xgen-operation-id-override: listIndexMeasurements
  "/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: getGroupHostFtsMetricIndexMeasurements
      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:
          description: List that contains the measurements that MongoDB Atlas reports
            for the associated data series.
          items:
            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
            type: string
          maxItems: 10
          type: array
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Atlas Search Metrics for One Index in One Namespace
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getIndexMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupHostFtsMetricIndexMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupHostFtsMetricIndexMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupHostFtsMetricIndexMeasurements
      x-xgen-operation-id-override: getIndexMeasurements
  "/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: listGroupHostFtsMetricMeasurements
      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:
          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:
            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
            type: string
          maxItems: 10
          type: array
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Atlas Search Hardware and Status Metrics
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs listMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupHostFtsMetricMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tListGroupHostFtsMetricMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupHostFtsMetricMeasurements
      x-xgen-operation-id-override: listMeasurements
  "/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 Service Account
        or API Key must have the Project Read Only role.
      operationId: listGroupIntegrations
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Active Third-Party Service Integrations
      tags:
      - Third-Party Integrations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api thirdPartyIntegrations listGroupIntegrations --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupIntegrationsApiParams{}\n\tsdkResp,
          httpResp, err := client.Third - PartyIntegrationsApi.\n\t\tListGroupIntegrationsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listGroupIntegrations
  "/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 Service Account or API Key must have
        the Organization Owner or Project Owner role.
      operationId: deleteGroupIntegration
      parameters:
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
          type: string
      - "$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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Third-Party Service Integration
      tags:
      - Third-Party Integrations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api thirdPartyIntegrations deleteGroupIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupIntegrationApiParams{}\n\thttpResp,
          err := client.Third - PartyIntegrationsApi.\n\t\tDeleteGroupIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-changelog:
        '2026-01-07': Log export to S3, Splunk, and Datadog is not supported by this
          API.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteGroupIntegration
    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 Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupIntegration
      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:
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ThirdPartyIntegration"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Third-Party Service Integration
      tags:
      - Third-Party Integrations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api thirdPartyIntegrations getGroupIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupIntegrationApiParams{}\n\tsdkResp,
          httpResp, err := client.Third - PartyIntegrationsApi.\n\t\tGetGroupIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-changelog:
        '2026-01-07': Log export to S3, Splunk, and Datadog is not supported by this
          API.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getGroupIntegration
    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 Service Account or API Key must have
        the Organization Owner or Project Owner role.
      operationId: createGroupIntegration
      parameters:
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Third-Party Service Integration
      tags:
      - Third-Party Integrations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api thirdPartyIntegrations createGroupIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupIntegrationApiParams{}\n\tsdkResp,
          httpResp, err := client.Third - PartyIntegrationsApi.\n\t\tCreateGroupIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-changelog:
        '2026-01-07': Log export to S3, Splunk, and Datadog is not supported by this
          API.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createGroupIntegration
    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 Service Account or API Key must
        have the Organization Owner or Project Owner role.
      operationId: updateGroupIntegration
      parameters:
      - description: Human-readable label that identifies the service which you want
          to integrate with MongoDB Cloud.
        in: path
        name: integrationType
        required: true
        schema:
          enum:
          - PAGER_DUTY
          - SLACK
          - DATADOG
          - NEW_RELIC
          - OPS_GENIE
          - VICTOR_OPS
          - WEBHOOK
          - HIP_CHAT
          - PROMETHEUS
          - MICROSOFT_TEAMS
          title: Integration Type
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Third-Party Service Integration
      tags:
      - Third-Party Integrations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api thirdPartyIntegrations updateGroupIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupIntegrationApiParams{}\n\tsdkResp,
          httpResp, err := client.Third - PartyIntegrationsApi.\n\t\tUpdateGroupIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-changelog:
        '2026-01-07': Log export to S3, Splunk, and Datadog is not supported by this
          API.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateGroupIntegration
  "/api/atlas/v2/groups/{groupId}/invites":
    get:
      deprecated: true
      description: Returns all pending invitations to the specified project. To use
        this resource, the requesting Service Account or API Key must have the Project
        Owner role.
      operationId: listGroupInvites
      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:
          format: email
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/GroupInvitation"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Invitations in One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects listGroupInvites --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupInvitesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tListGroupInvitesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroupInvites
    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 Service Account or API
        Key must have the Project Owner role.
      operationId: updateGroupInvites
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Invitation in One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects updateGroupInvites --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupInvitesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tUpdateGroupInvitesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupInvites
    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 Service Account
        or API Key must have the Project Owner role.
      operationId: createGroupInvite
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create Invitation for One MongoDB Cloud User in One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects createGroupInvite --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupInviteApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tCreateGroupInviteWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createGroupInvite
  "/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 Service Account or API Key must have
        the Project Owner role. Note: deleting a project invitation does not delete
        an organization invitation even if they were created together.'
      operationId: deleteGroupInvite
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Invitation from One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects deleteGroupInvite --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupInviteApiParams{}\n\thttpResp,
          err := client.ProjectsApi.\n\t\tDeleteGroupInviteWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroupInvite
    get:
      deprecated: true
      description: Returns the details of one pending invitation to the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Owner role.
      operationId: getGroupInvite
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/GroupInvitation"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Invitation in One Project by Invitation ID
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getGroupInvite --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupInviteApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupInviteWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupInvite
    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 Service Account or API Key must have the Project Owner role.
      operationId: updateGroupInviteById
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Invitation in One Project by Invitation ID
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects updateInviteById --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupInviteByIdApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tUpdateGroupInviteByIdWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupInviteById
      x-xgen-method-verb-override:
        customMethod: false
        verb: updateById
      x-xgen-operation-id-override: updateInviteById
  "/api/atlas/v2/groups/{groupId}/ipAddresses":
    get:
      description: Returns all IP addresses for this project. To use this resource,
        the requesting Service Account or API Key must have the Project Read Only
        role.
      operationId: getGroupIpAddresses
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All IP Addresses for One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getGroupIpAddresses --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupIpAddressesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupIpAddressesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupIpAddresses
  "/api/atlas/v2/groups/{groupId}/limits":
    get:
      description: Returns all the limits for the specified project. To use this resource,
        the requesting Service Account or API Key must have the Project Read Only
        role.
      operationId: listGroupLimits
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/DataFederationLimit"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Limits for One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects listGroupLimits --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupLimitsApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tListGroupLimitsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listGroupLimits
  "/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 Service Account or API Key must have
        the Project Owner role.
      operationId: deleteGroupLimit
      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 | 100 |
          | `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 | 100 |
          | `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 Service 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:
          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
          type: string
      - "$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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Project Limit
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects deleteGroupLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupLimitApiParams{}\n\thttpResp,
          err := client.ProjectsApi.\n\t\tDeleteGroupLimitWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteGroupLimit
    get:
      description: Returns the specified limit for the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Read Only role.
      operationId: getGroupLimit
      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 | 100 |
          | `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 | 100 |
          | `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 Service 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:
          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
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Limit for One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getGroupLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupLimitApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupLimitWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupLimit
    patch:
      description: |-
        Sets the specified project limit. To use this resource, the requesting Service Account or 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: setGroupLimit
      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 | 100 |
          | `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 | 100 |
          | `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 Service 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:
          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
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Set One Project Limit
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects setGroupLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.SetGroupLimitApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tSetGroupLimitWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setGroupLimit
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: set
  "/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 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. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: Validate Migration
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration
      operationId: createGroupLiveMigration
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/LiveMigrationRequest20240530"
            x-xgen-version: '2024-05-30'
        description: One migration to be created.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/LiveMigrationResponse"
              x-xgen-version: '2024-05-30'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Migration for One Local Managed Cluster to MongoDB Atlas
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService createGroupLiveMigration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupLiveMigrationApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tCreateGroupLiveMigrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createGroupLiveMigration
  "/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. Deprecated versions:
        v2-{2023-01-01}'
      operationId: validateGroupLiveMigrations
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/LiveMigrationRequest20240530"
            x-xgen-version: '2024-05-30'
        description: One migration to be validated.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/LiveImportValidation"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Validate One Migration Request
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService validateLiveMigrations --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ValidateGroupLiveMigrationsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tValidateGroupLiveMigrationsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateGroupLiveMigrations
      x-xgen-method-verb-override:
        customMethod: true
      x-xgen-operation-id-override: validateLiveMigrations
  "/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: getGroupLiveMigrationValidateStatus
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Unique 24-hexadecimal digit string that identifies the validation
          job.
        in: path
        name: validationId
        required: true
        schema:
          example: 507f1f77bcf86cd799439011
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Migration Validation Job
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService getMigrationValidateStatus --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupLiveMigrationValidateStatusApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tGetGroupLiveMigrationValidateStatusWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getGroupLiveMigrationValidateStatus
      x-xgen-method-verb-override:
        customMethod: true
        verb: getStatus
      x-xgen-operation-id-override: getMigrationValidateStatus
  "/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: getGroupLiveMigration
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Migration Job
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService getGroupLiveMigration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupLiveMigrationApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tGetGroupLiveMigrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getGroupLiveMigration
  "/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: cutoverGroupLiveMigration
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Cut Over One Migrated Cluster
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService cutoverMigration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CutoverGroupLiveMigrationApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tCutoverGroupLiveMigrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverGroupLiveMigration
      x-xgen-method-verb-override:
        customMethod: true
      x-xgen-operation-id-override: cutoverMigration
  "/api/atlas/v2/groups/{groupId}/logIntegrations":
    get:
      description: Returns all log integration configurations for the project. Optionally
        filter by integration type. To use this resource, the requesting Service Account
        or API Key must have the Organization Owner or Project Owner role.
      operationId: listGroupLogIntegrations
      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: Optional filter by integration type (e.g., `S3_LOG_EXPORT`).
        in: query
        name: integrationType
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/PaginatedLogIntegrationResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Active Log Integrations
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport listGroupLogIntegrations --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupLogIntegrationsApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tListGroupLogIntegrationsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/listGroupLogIntegrations
    post:
      description: Creates a new log integration configuration identified by a unique
        ID. To use this resource, the requesting Service Account or API Key must have
        the Organization Owner or Project Owner role.
      operationId: createGroupLogIntegration
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2025-03-12+json:
            schema:
              "$ref": "#/components/schemas/LogIntegrationRequest"
        description: Log integration configuration to create.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/LogIntegrationResponse"
              x-xgen-version: '2025-03-12'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Log Integration
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport createGroupLogIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupLogIntegrationApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tCreateGroupLogIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createGroupLogIntegration
  "/api/atlas/v2/groups/{groupId}/logIntegrations/{id}":
    delete:
      description: Removes the configuration for one log integration identified by
        its unique ID. To use this resource, the requesting Service Account or API
        Key must have the Organization Owner or Project Owner role.
      operationId: deleteGroupLogIntegration
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique identifier of the log integration configuration.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2025-03-12+json:
              x-xgen-version: '2025-03-12'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Log Integration
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport deleteGroupLogIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupLogIntegrationApiParams{}\n\thttpResp,
          err := client.Push - BasedLogExportApi.\n\t\tDeleteGroupLogIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deleteGroupLogIntegration
    get:
      description: Returns the configuration for one log integration identified by
        its unique ID. To use this resource, the requesting Service Account or API
        Key must have the Organization Owner or Project Owner role.
      operationId: getGroupLogIntegration
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique identifier of the log integration configuration.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/LogIntegrationResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Log Integration
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport getGroupLogIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupLogIntegrationApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tGetGroupLogIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getGroupLogIntegration
    put:
      description: Updates the configuration for one log integration identified by
        its unique ID. To use this resource, the requesting Service Account or API
        Key must have the Organization Owner or Project Owner role.
      operationId: updateGroupLogIntegration
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique identifier of the log integration configuration.
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-03-12+json:
            schema:
              "$ref": "#/components/schemas/LogIntegrationRequest"
        description: Updated log integration configuration.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/LogIntegrationResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Log Integration
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport updateGroupLogIntegration --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupLogIntegrationApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tUpdateGroupLogIntegrationWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updateGroupLogIntegration
  "/api/atlas/v2/groups/{groupId}/maintenanceWindow":
    delete:
      description: Resets the maintenance window for the specified project. To use
        this resource, the requesting Service Account or 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 Service Account or API Key must have the Project
        Owner role.
      operationId: resetGroupMaintenanceWindow
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Reset One Maintenance Window for One Project
      tags:
      - Maintenance Windows
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api maintenanceWindows resetMaintenanceWindow --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ResetGroupMaintenanceWindowApiParams{}\n\thttpResp,
          err := client.MaintenanceWindowsApi.\n\t\tResetGroupMaintenanceWindowWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetGroupMaintenanceWindow
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: reset
      x-xgen-operation-id-override: resetMaintenanceWindow
    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 Service Account or API Key must have the Project Owner role.
      operationId: getGroupMaintenanceWindow
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Maintenance Window for One Project
      tags:
      - Maintenance Windows
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api maintenanceWindows getMaintenanceWindow --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupMaintenanceWindowApiParams{}\n\tsdkResp,
          httpResp, err := client.MaintenanceWindowsApi.\n\t\tGetGroupMaintenanceWindowWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getGroupMaintenanceWindow
      x-xgen-operation-id-override: getMaintenanceWindow
    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. Updating the maintenance window
        will reset any maintenance deferrals for this project. To use this resource,
        the requesting Service Account or API Key must have the Project Owner role.
      operationId: updateGroupMaintenanceWindow
      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:
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Maintenance Window for One Project
      tags:
      - Maintenance Windows
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api maintenanceWindows updateMaintenanceWindow --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupMaintenanceWindowApiParams{}\n\tsdkResp,
          httpResp, err := client.MaintenanceWindowsApi.\n\t\tUpdateGroupMaintenanceWindowWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateGroupMaintenanceWindow
      x-xgen-operation-id-override: updateMaintenanceWindow
  "/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer":
    post:
      description: Toggles automatic deferral of the maintenance window for the specified
        project. When automatic deferral is enabled, all maintenance windows are deferred
        for one week. This endpoint controls the same underlying feature as the `autoDeferOnceEnabled`
        field in the PATCH `/maintenanceWindow` endpoint. The difference is that this
        endpoint toggles the current value (switches from enabled to disabled or vice
        versa), while the `autoDeferOnceEnabled` field allows you to set a specific
        value. For most use cases, the PATCH endpoint with `autoDeferOnceEnabled`
        is recommended because it allows setting an explicit value rather than toggling.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role.
      operationId: toggleGroupMaintenanceWindowAutoDefer
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Toggle Automatic Deferral of Maintenance for One Project
      tags:
      - Maintenance Windows
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api maintenanceWindows toggleMaintenanceAutoDefer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ToggleGroupMaintenanceWindowAutoDeferApiParams{}\n\tsdkResp,
          httpResp, err := client.MaintenanceWindowsApi.\n\t\tToggleGroupMaintenanceWindowAutoDeferWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleGroupMaintenanceWindowAutoDefer
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: toggle
      x-xgen-operation-id-override: toggleMaintenanceAutoDefer
  "/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
        Service Account or API Key must have the Project Owner role.
      operationId: deferGroupMaintenanceWindow
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Defer One Maintenance Window for One Project
      tags:
      - Maintenance Windows
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api maintenanceWindows deferMaintenanceWindow --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeferGroupMaintenanceWindowApiParams{}\n\tsdkResp,
          httpResp, err := client.MaintenanceWindowsApi.\n\t\tDeferGroupMaintenanceWindowWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferGroupMaintenanceWindow
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: deferMaintenanceWindow
  "/api/atlas/v2/groups/{groupId}/managedSlowMs":
    get:
      description: Get whether the Managed Slow MS feature is enabled.
      operationId: getGroupManagedSlowMs
      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: boolean
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Managed Slow Operation Threshold Status
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor getManagedSlowMs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupManagedSlowMsApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tGetGroupManagedSlowMsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getGroupManagedSlowMs
      x-xgen-operation-id-override: getManagedSlowMs
  "/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 Service
        Account or API Key must have the Project Owner role.
      operationId: disableGroupManagedSlowMs
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Disable Managed Slow Operation Threshold
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor disableManagedSlowMs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DisableGroupManagedSlowMsApiParams{}\n\thttpResp,
          err := client.PerformanceAdvisorApi.\n\t\tDisableGroupManagedSlowMsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableGroupManagedSlowMs
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: disableManagedSlowMs
  "/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 Service
        Account or API Key must have the Project Owner role.
      operationId: enableGroupManagedSlowMs
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Enable Managed Slow Operation Threshold
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor enableManagedSlowMs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.EnableGroupManagedSlowMsApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tEnableGroupManagedSlowMsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableGroupManagedSlowMs
      x-xgen-method-verb-override:
        customMethod: true
      x-xgen-operation-id-override: enableManagedSlowMs
  "/api/atlas/v2/groups/{groupId}/mongoDBVersions":
    get:
      description: Returns the MongoDB Long Term Support Major Versions available
        to new clusters in this project.
      operationId: getGroupMongoDbVersions
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Filter results to only one cloud provider.
        in: query
        name: cloudProvider
        schema:
          enum:
          - AWS
          - AZURE
          - GCP
          - TENANT
          type: string
      - description: Filter results to only one instance size.
        in: query
        name: instanceSize
        schema:
          example: M10
          type: string
      - description: Filter results to only the default values per tier. This value
          must be DEFAULT.
        in: query
        name: defaultStatus
        schema:
          enum:
          - DEFAULT
          type: string
      - description: Number of items that the response returns per page.
        in: query
        name: itemsPerPage
        schema:
          default: 100
          example: 100
          format: int64
          minimum: 1
          type: integer
      - "$ref": "#/components/parameters/pageNum"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedAvailableVersionView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Available MongoDB LTS Versions for Clusters in One Project
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getMongoDbVersions --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupMongoDbVersionsApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupMongoDbVersionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupMongoDbVersions
      x-xgen-operation-id-override: getMongoDbVersions
  "/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 Service
        Account or API Key must have the Project Read Only role.
      operationId: listGroupPeers
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedContainerPeerView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Network Peering Connections in One Project
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering listGroupPeers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupPeersApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tListGroupPeersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listGroupPeers
    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 Service Account
        or API Key must have the Project Owner role or Project Network Access Manager
        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: createGroupPeer
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Network Peering Connection
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering createGroupPeer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPeerApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tCreateGroupPeerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Network Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createGroupPeer
  "/api/atlas/v2/groups/{groupId}/peers/{peerId}":
    delete:
      description: Removes one network peering connection in the specified project.
        If you remove 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 Service Account or API Key must
        have the Project Owner role or Project Network Access Manager role.
      operationId: deleteGroupPeer
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '202':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/RequestAccepted"
              x-xgen-version: '2023-01-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Network Peering Connection
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering deleteGroupPeer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPeerApiParams{}\n\thttpResp,
          err := client.NetworkPeeringApi.\n\t\tDeleteGroupPeerWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}"
      x-rolesRequirements:
      - Project Network Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deleteGroupPeer
    get:
      description: Returns details about one specified network peering connection
        in the specified project. To use this resource, the requesting Service Account
        or API Key must have the Project Read Only role.
      operationId: getGroupPeer
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Network Peering Connection in One Project
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering getGroupPeer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPeerApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tGetGroupPeerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getGroupPeer
    patch:
      description: Updates one specified network peering connection in the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Owner role or Project Network Access Manager role.
      operationId: updateGroupPeer
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Network Peering Connection
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering updateGroupPeer --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupPeerApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tUpdateGroupPeerWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Network Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updateGroupPeer
  "/api/atlas/v2/groups/{groupId}/pipelines":
    get:
      deprecated: true
      description: Returns a list of Data Lake Pipelines. To use this resource, the
        requesting Service Account or API Key must have the Project Read Only role.
      operationId: listGroupPipelines
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/DataLakeIngestionPipeline"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Data Lake Pipelines in One Project
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines listPipelines --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupPipelinesApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tListGroupPipelinesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listGroupPipelines
      x-xgen-operation-id-override: listPipelines
    post:
      deprecated: true
      description: Creates one Data Lake Pipeline.
      externalDocs:
        description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation
          Guide.
        url: https://dochub.mongodb.org/core/data-lake-deprecation
      operationId: createGroupPipeline
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines createPipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPipelineApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tCreateGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createGroupPipeline
      x-xgen-operation-id-override: createPipeline
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}":
    delete:
      deprecated: true
      description: Removes one Data Lake Pipeline.
      operationId: deleteGroupPipeline
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines deletePipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPipelineApiParams{}\n\thttpResp,
          err := client.DataLakePipelinesApi.\n\t\tDeleteGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deleteGroupPipeline
      x-xgen-operation-id-override: deletePipeline
    get:
      deprecated: true
      description: Returns the details of one Data Lake Pipeline within the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupPipeline
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DataLakeIngestionPipeline"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines getPipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPipelineApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tGetGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipeline
      x-xgen-operation-id-override: getPipeline
    patch:
      deprecated: true
      description: Updates one Data Lake Pipeline.
      operationId: updateGroupPipeline
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines updatePipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupPipelineApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tUpdateGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updateGroupPipeline
      x-xgen-operation-id-override: updatePipeline
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules":
    get:
      deprecated: true
      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 Service
        Account or API Key must have the Project Read Only role.
      operationId: getGroupPipelineAvailableSchedules
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/DiskBackupApiPolicyItem"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Ingestion Schedules for One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines getAvailablePipelineSchedules --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPipelineAvailableSchedulesApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tGetGroupPipelineAvailableSchedulesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineAvailableSchedules
      x-xgen-operation-id-override: getAvailablePipelineSchedules
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots":
    get:
      deprecated: true
      description: Returns a list of backup snapshots that you can use to trigger
        an on demand pipeline run. To use this resource, the requesting Service Account
        or API Key must have the Project Read Only role.
      operationId: getGroupPipelineAvailableSnapshots
      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:
          format: date-time
          type: string
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedBackupSnapshotView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Backup Snapshots for One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines getAvailablePipelineSnapshots --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPipelineAvailableSnapshotsApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tGetGroupPipelineAvailableSnapshotsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineAvailableSnapshots
      x-xgen-operation-id-override: getAvailablePipelineSnapshots
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause":
    post:
      deprecated: true
      description: Pauses ingestion for a Data Lake Pipeline within the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role.
      operationId: pauseGroupPipeline
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DataLakeIngestionPipeline"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Pause One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines pausePipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.PauseGroupPipelineApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tPauseGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pauseGroupPipeline
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: pausePipeline
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume":
    post:
      deprecated: true
      description: Resumes ingestion for a Data Lake Pipeline within the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role.
      operationId: resumeGroupPipeline
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/DataLakeIngestionPipeline"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Resume One Data Lake Pipeline
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines resumePipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ResumeGroupPipelineApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tResumeGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumeGroupPipeline
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: resumePipeline
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs":
    get:
      deprecated: true
      description: Returns a list of past Data Lake Pipeline runs. To use this resource,
        the requesting Service Account or API Key must have the Project Read Only
        role.
      operationId: listGroupPipelineRuns
      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:
          format: date-time
          type: string
      - description: Human-readable label that identifies the Data Lake Pipeline.
        in: path
        name: pipelineName
        required: true
        schema:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedPipelineRunView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Data Lake Pipeline Runs in One Project
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines listPipelineRuns --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupPipelineRunsApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tListGroupPipelineRunsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listGroupPipelineRuns
      x-xgen-operation-id-override: listPipelineRuns
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}":
    delete:
      deprecated: true
      description: Deletes dataset that Atlas generated during the specified pipeline
        run.
      operationId: deleteGroupPipelineRun
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      - description: Unique 24-hexadecimal character string that identifies a Data
          Lake Pipeline run.
        in: path
        name: pipelineRunId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '202':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/RequestAccepted"
              x-xgen-version: '2023-01-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Pipeline Run Dataset
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines deletePipelineRun --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPipelineRunApiParams{}\n\thttpResp,
          err := client.DataLakePipelinesApi.\n\t\tDeleteGroupPipelineRunWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deleteGroupPipelineRun
      x-xgen-operation-id-override: deletePipelineRun
    get:
      deprecated: true
      description: Returns the details of one Data Lake Pipeline run within the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupPipelineRun
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      - description: Unique 24-hexadecimal character string that identifies a Data
          Lake Pipeline run.
        in: path
        name: pipelineRunId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/IngestionPipelineRun"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Data Lake Pipeline Run
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines getPipelineRun --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPipelineRunApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tGetGroupPipelineRunWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getGroupPipelineRun
      x-xgen-operation-id-override: getPipelineRun
  "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger":
    post:
      deprecated: true
      description: Triggers a Data Lake Pipeline ingestion of a specified snapshot.
      operationId: triggerGroupPipeline
      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:
          pattern: ^[^/\\ "$]{1,64}$
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Trigger On-Demand Snapshot Ingestion
      tags:
      - Data Lake Pipelines
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataLakePipelines triggerPipeline --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.TriggerGroupPipelineApiParams{}\n\tsdkResp,
          httpResp, err := client.DataLakePipelinesApi.\n\t\tTriggerGroupPipelineWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2025-09-30'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerGroupPipeline
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: triggerPipeline
  "/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 Service Account or API Key
        must have the Project Owner role.
      externalDocs:
        description: Private Endpoint Concepts
        url: https://dochub.mongodb.org/core/private-endpoint-concepts
      operationId: createGroupPrivateEndpointEndpointService
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices createPrivateEndpointService --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPrivateEndpointEndpointServiceApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tCreateGroupPrivateEndpointEndpointServiceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createGroupPrivateEndpointEndpointService
      x-xgen-operation-id-override: createPrivateEndpointService
  "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService/{endpointServiceId}":
    patch:
      description: Updates the specified private endpoint service for the project.
        The cloud service provider manages the private endpoint service that belongs
        to the project. To use this resource, the requesting Service Account or API
        Key must have the Project Owner role.
      operationId: updateGroupPrivateEndpointEndpointService
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service that you want to update.
        in: path
        name: endpointServiceId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              "$ref": "#/components/schemas/ApiAtlasModifyEndpointServiceRequestView"
        description: Updates to apply to the private endpoint service.
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices updatePrivateEndpointService --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupPrivateEndpointEndpointServiceApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tUpdateGroupPrivateEndpointEndpointServiceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService/{endpointServiceId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService/{endpointServiceId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/updateGroupPrivateEndpointEndpointService
      x-xgen-operation-id-override: updatePrivateEndpointService
  "/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
        Service Account or API Key must have the Project Read Only role.
      operationId: getGroupPrivateEndpointRegionalMode
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Regionalized Private Endpoint Status
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices getRegionalEndpointMode --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPrivateEndpointRegionalModeApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tGetGroupPrivateEndpointRegionalModeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointRegionalMode
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getRegionalEndpointMode
    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 Service
        Account or 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: toggleGroupPrivateEndpointRegionalMode
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Toggle Regionalized Private Endpoint Status
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices toggleRegionalEndpointMode --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ToggleGroupPrivateEndpointRegionalModeApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tToggleGroupPrivateEndpointRegionalModeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleGroupPrivateEndpointRegionalMode
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: toggle
      x-xgen-operation-id-override: toggleRegionalEndpointMode
  "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint":
    get:
      deprecated: true
      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.

        This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. This endpoint will be sunset on January 22, 2026.
      operationId: listGroupPrivateEndpointServerlessInstanceEndpoint
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/ServerlessTenantEndpoint"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Private Endpoints for One Serverless Instance
      tags:
      - Serverless Private Endpoints
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupPrivateEndpointServerlessInstanceEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.ServerlessPrivateEndpointsApi.\n\t\tListGroupPrivateEndpointServerlessInstanceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listGroupPrivateEndpointServerlessInstanceEndpoint
      x-xgen-operation-id-override: listServerlessPrivateEndpoint
    post:
      deprecated: true
      description: |-
        Creates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or 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.

        This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. This endpoint will be sunset on January 22, 2026.
      externalDocs:
        description: Set Up a Private Endpoint for a Serverless Instance Tutorial
        url: https://dochub.mongodb.org/core/serverless-private-endpoint
      operationId: createGroupPrivateEndpointServerlessInstanceEndpoint
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPrivateEndpointServerlessInstanceEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.ServerlessPrivateEndpointsApi.\n\t\tCreateGroupPrivateEndpointServerlessInstanceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createGroupPrivateEndpointServerlessInstanceEndpoint
      x-xgen-operation-id-override: createServerlessPrivateEndpoint
  "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}":
    delete:
      deprecated: true
      description: |-
        Remove one private endpoint from one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

        This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. This endpoint will be sunset on January 22, 2026.
      operationId: deleteGroupPrivateEndpointServerlessInstanceEndpoint
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the tenant
          endpoint which will be removed.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPrivateEndpointServerlessInstanceEndpointApiParams{}\n\thttpResp,
          err := client.ServerlessPrivateEndpointsApi.\n\t\tDeleteGroupPrivateEndpointServerlessInstanceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteGroupPrivateEndpointServerlessInstanceEndpoint
      x-xgen-operation-id-override: deleteServerlessPrivateEndpoint
    get:
      deprecated: true
      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.

        This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. This endpoint will be sunset on January 22, 2026.
      operationId: getGroupPrivateEndpointServerlessInstanceEndpoint
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the tenant
          endpoint.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ServerlessTenantEndpoint"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPrivateEndpointServerlessInstanceEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.ServerlessPrivateEndpointsApi.\n\t\tGetGroupPrivateEndpointServerlessInstanceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getGroupPrivateEndpointServerlessInstanceEndpoint
      x-xgen-operation-id-override: getServerlessPrivateEndpoint
    patch:
      deprecated: true
      description: |-
        Updates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

        This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. This endpoint will be sunset on January 22, 2026.
      operationId: updateGroupPrivateEndpointServerlessInstanceEndpoint
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the tenant
          endpoint which will be updated.
        in: path
        name: endpointId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Private Endpoint for One Serverless Instance
      tags:
      - Serverless Private Endpoints
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint
          --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupPrivateEndpointServerlessInstanceEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.ServerlessPrivateEndpointsApi.\n\t\tUpdateGroupPrivateEndpointServerlessInstanceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateGroupPrivateEndpointServerlessInstanceEndpoint
      x-xgen-operation-id-override: updateServerlessPrivateEndpoint
  "/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 Service Account or API Key must have the Project Read Only
        role.
      operationId: listGroupPrivateEndpointEndpointService
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/EndpointService"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Private Endpoint Services for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices listPrivateEndpointService --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupPrivateEndpointEndpointServiceApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tListGroupPrivateEndpointEndpointServiceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listGroupPrivateEndpointEndpointService
      x-xgen-operation-id-override: listPrivateEndpointService
  "/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 Service Account or API
        Key must have the Project Owner role.
      operationId: deleteGroupPrivateEndpointEndpointService
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service that you want to delete.
        in: path
        name: endpointServiceId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices deletePrivateEndpointService --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPrivateEndpointEndpointServiceApiParams{}\n\thttpResp,
          err := client.PrivateEndpointServicesApi.\n\t\tDeleteGroupPrivateEndpointEndpointServiceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deleteGroupPrivateEndpointEndpointService
      x-xgen-operation-id-override: deletePrivateEndpointService
    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 Service Account or API Key must have the Project Read Only
        role.
      operationId: getGroupPrivateEndpointEndpointService
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the private
          endpoint service that you want to return.
        in: path
        name: endpointServiceId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/EndpointService"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Private Endpoint Service for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices getPrivateEndpointService --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPrivateEndpointEndpointServiceApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tGetGroupPrivateEndpointEndpointServiceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointEndpointService
      x-xgen-operation-id-override: getPrivateEndpointService
  "/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 Service Account or 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: createGroupPrivateEndpointEndpointServiceEndpoint
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Private Endpoint for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices createPrivateEndpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPrivateEndpointEndpointServiceEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tCreateGroupPrivateEndpointEndpointServiceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createGroupPrivateEndpointEndpointServiceEndpoint
      x-xgen-operation-id-override: createPrivateEndpoint
  "/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
        Service Account or API Key must have the Project Owner role.
      operationId: deleteGroupPrivateEndpointEndpointServiceEndpoint
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      - 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:
          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._()]+)"
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Private Endpoint for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices deletePrivateEndpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPrivateEndpointEndpointServiceEndpointApiParams{}\n\thttpResp,
          err := client.PrivateEndpointServicesApi.\n\t\tDeleteGroupPrivateEndpointEndpointServiceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deleteGroupPrivateEndpointEndpointServiceEndpoint
      x-xgen-operation-id-override: deletePrivateEndpoint
    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 Service Account or API Key must have the Project Read Only
        role.
      operationId: getGroupPrivateEndpointEndpointServiceEndpoint
      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:
          default: AWS
          enum:
          - AWS
          - AZURE
          - GCP
          type: string
      - 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:
          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._()]+)"
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PrivateLinkEndpoint"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Private Endpoint for One Provider
      tags:
      - Private Endpoint Services
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api privateEndpointServices getPrivateEndpoint --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPrivateEndpointEndpointServiceEndpointApiParams{}\n\tsdkResp,
          httpResp, err := client.PrivateEndpointServicesApi.\n\t\tGetGroupPrivateEndpointEndpointServiceEndpointWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getGroupPrivateEndpointEndpointServiceEndpoint
      x-xgen-operation-id-override: getPrivateEndpoint
  "/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 Service Account
        or 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: verifyGroupPrivateIpMode
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Verify Connect via Peering-Only Mode for One Project
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering verifyPrivateIpMode --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.VerifyGroupPrivateIpModeApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tVerifyGroupPrivateIpModeWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyGroupPrivateIpMode
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: verify
      x-xgen-operation-id-override: verifyPrivateIpMode
    patch:
      deprecated: true
      description: Disables Connect via Peering Only mode for the specified project.
        To use this resource, the requesting Service Account or 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: disableGroupPrivateIpModePeering
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Disable Connect via Peering-Only Mode for One Project
      tags:
      - Network Peering
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api networkPeering disablePeering --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DisableGroupPrivateIpModePeeringApiParams{}\n\tsdkResp,
          httpResp, err := client.NetworkPeeringApi.\n\t\tDisableGroupPrivateIpModePeeringWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disableGroupPrivateIpModePeering
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: disablePeering
      x-xgen-operation-id-override: disablePeering
  "/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
        Service Account or API Key must have the Project Read Only or Project Charts
        Admin roles.
      operationId: listGroupPrivateNetworkSettingEndpointIds
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Federated Database Instance and Online Archive Private Endpoints
        in One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation listPrivateEndpointIds --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupPrivateNetworkSettingEndpointIdsApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tListGroupPrivateNetworkSettingEndpointIdsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listGroupPrivateNetworkSettingEndpointIds
      x-xgen-operation-id-override: listPrivateEndpointIds
    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. For
        the latest list of supported regions and their service names, see the external
        documentation. To use this resource, the requesting Service Account or API
        Key must have the Project Owner or Project Charts Admin roles.
      externalDocs:
        description: Atlas Data Federation Regions and Service Names
        url: https://www.mongodb.com/docs/atlas/data-federation/tutorial/config-private-endpoint/
      operationId: createGroupPrivateNetworkSettingEndpointId
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Federated Database Instance and Online Archive Private Endpoint
        for One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation createPrivateEndpointId --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPrivateNetworkSettingEndpointIdApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tCreateGroupPrivateNetworkSettingEndpointIdWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createGroupPrivateNetworkSettingEndpointId
      x-xgen-operation-id-override: createPrivateEndpointId
  "/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
        Service Account or API Key must have the Project Owner role.
      operationId: deleteGroupPrivateNetworkSettingEndpointId
      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:
          pattern: "^vpce-[0-9a-f]{17}$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Federated Database Instance and Online Archive Private Endpoint
        from One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation deletePrivateEndpointId --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPrivateNetworkSettingEndpointIdApiParams{}\n\thttpResp,
          err := client.DataFederationApi.\n\t\tDeleteGroupPrivateNetworkSettingEndpointIdWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteGroupPrivateNetworkSettingEndpointId
      x-xgen-operation-id-override: deletePrivateEndpointId
    get:
      description: Returns the specified private endpoint for Federated Database Instances
        or Online Archives in the specified project. To use this resource, the requesting
        Service Account or API Key must have the Project Read Only or Project Charts
        Admin roles.
      operationId: getGroupPrivateNetworkSettingEndpointId
      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:
          pattern: "^vpce-[0-9a-f]{17}$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Federated Database Instance and Online Archive Private Endpoint
        in One Project
      tags:
      - Data Federation
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api dataFederation getPrivateEndpointId --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPrivateNetworkSettingEndpointIdApiParams{}\n\tsdkResp,
          httpResp, err := client.DataFederationApi.\n\t\tGetGroupPrivateNetworkSettingEndpointIdWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getGroupPrivateNetworkSettingEndpointId
      x-xgen-operation-id-override: getPrivateEndpointId
  "/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
        Service Account or API Key must have the Project Read Only role.
      operationId: listGroupProcesses
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All MongoDB Processes in One Project
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs listGroupProcesses --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessesApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tListGroupProcessesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcesses
  "/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 Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupProcess
      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:
          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})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ApiHostView_Atlas"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One MongoDB Process by ID
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getGroupProcess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupProcessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcess
  "/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: getGroupProcessCollStatNamespaces
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Ranked Namespaces from One Host
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics getProcessNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessCollStatNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tGetGroupProcessCollStatNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getGroupProcessCollStatNamespaces
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getProcessNamespaces
  "/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`, serverless, and Flex
        clusters have some operational limits. The MongoDB Cloud process must be a
        `mongod`. To use this resource, the requesting Service Account or API Key
        must have the Project Read Only role.
      externalDocs:
        description: Operational Limits
        url: https://www.mongodb.com/docs/atlas/reference/limitations/
      operationId: listGroupProcessDatabases
      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:
          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})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedDatabaseView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Available Databases for One MongoDB Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs listDatabases --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessDatabasesApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tListGroupProcessDatabasesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcessDatabases
      x-xgen-operation-id-override: listDatabases
  "/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 Service Account or API Key must
        have the Project Read Only role.
      operationId: getGroupProcessDatabase
      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:
          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})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/MesurementsDatabase"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Database for One MongoDB Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getDatabase --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessDatabaseApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupProcessDatabaseWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDatabase
      x-xgen-operation-id-override: getDatabase
  "/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 Service Account
        or API Key must have the Project Read Only role.
      operationId: getGroupProcessDatabaseMeasurements
      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:
          items:
            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
            type: string
          maxItems: 10
          minItems: 1
          type: array
          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:
          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})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Measurements for One Database in One MongoDB Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getDatabaseMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessDatabaseMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupProcessDatabaseMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDatabaseMeasurements
      x-xgen-operation-id-override: getDatabaseMeasurements
  "/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 Service Account
        or API Key must have the Project Read Only role.
      operationId: listGroupProcessDisks
      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:
          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})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedDiskPartitionView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Available Disks for One MongoDB Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs listProcessDisks --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessDisksApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tListGroupProcessDisksWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listGroupProcessDisks
      x-xgen-operation-id-override: listProcessDisks
  "/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 Service
        Account or API Key must have the Project Read Only role.
      operationId: getGroupProcessDisk
      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:
          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})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/MeasurementDiskPartition"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Measurements for One Disk
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getProcessDisk --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessDiskApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupProcessDiskWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDisk
      x-xgen-operation-id-override: getProcessDisk
  "/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 Service Account or API Key must have the Project Read Only role.
      operationId: getGroupProcessDiskMeasurements
      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:
          items:
            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
            - DISK_PARTITION_THROUGHPUT_READ
            - DISK_PARTITION_THROUGHPUT_WRITE
            - DISK_QUEUE_DEPTH
            type: string
          maxItems: 10
          minItems: 1
          type: array
          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:
          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})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Measurements of One Disk for One MongoDB Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getProcessDiskMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessDiskMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupProcessDiskMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessDiskMeasurements
      x-xgen-operation-id-override: getProcessDiskMeasurements
  "/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 Service Account or API Key must have the Project Read Only role.
      operationId: getGroupProcessMeasurements
      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:
          items:
            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
            - CACHE_FILL_RATIO
            - DIRTY_FILL_RATIO
            - 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_TTL_DELETED
            - OPCOUNTER_GETMORE
            - OPCOUNTER_INSERT
            - OPCOUNTER_QUERY
            - OPCOUNTER_REPL_CMD
            - OPCOUNTER_REPL_DELETE
            - OPCOUNTER_REPL_INSERT
            - OPCOUNTER_REPL_UPDATE
            - OPCOUNTER_UPDATE
            - OPERATIONS_SCAN_AND_ORDER
            - OPERATIONS_QUERIES_KILLED
            - 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
            - OPERATION_THROTTLING_REJECTED_OPERATIONS
            - QUERY_SPILL_TO_DISK_DURING_SORT
            type: string
          maxItems: 10
          minItems: 1
          type: array
          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:
          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})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Measurements for One MongoDB Process
      tags:
      - Monitoring and Logs
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api monitoringAndLogs getProcessMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupProcessMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.MonitoringandLogsApi.\n\t\tGetGroupProcessMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getGroupProcessMeasurements
      x-xgen-operation-id-override: getProcessMeasurements
  "/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 Service Account or API
        Key must have the Project Read Only role.
      operationId: listGroupProcessPerformanceAdvisorNamespaces
      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:
          format: int64
          type: integer
      - 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:
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
          type: string
      - 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:
          format: int64
          minimum: 1199145600000
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/Namespaces"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Namespaces for One Host
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor listPerformanceAdvisorNamespaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessPerformanceAdvisorNamespacesApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tListGroupProcessPerformanceAdvisorNamespacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorNamespaces
      x-xgen-operation-id-override: listPerformanceAdvisorNamespaces
  "/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 Service Account or API Key must have
        any Project Data Access role or the Project Observability Viewer role.
      operationId: listGroupProcessPerformanceAdvisorSlowQueryLogs
      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:
          format: int64
          type: integer
      - 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:
          items:
            type: string
          type: array
        style: form
      - description: Maximum number of lines from the log to return.
        in: query
        name: nLogs
        schema:
          default: 20000
          format: int64
          maximum: 20000
          minimum: 0
          type: integer
      - 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:
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
          type: string
      - 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:
          format: int64
          minimum: 1199145600000
          type: integer
      - description: Whether or not to include metrics extracted from the slow query
          log as separate fields.
        in: query
        name: includeMetrics
        schema:
          default: false
          type: boolean
      - description: Whether or not to include the replica state of the host when
          the slow query log was generated as a separate field.
        in: query
        name: includeReplicaState
        schema:
          default: false
          type: boolean
      - description: Whether or not to include the operation type (read/write/command)
          extracted from the slow query log as a separate field.
        in: query
        name: includeOpType
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PerformanceAdvisorSlowQueryList"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Slow Queries
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor listSlowQueryLogs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessPerformanceAdvisorSlowQueryLogsApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tListGroupProcessPerformanceAdvisorSlowQueryLogsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"
      x-rolesRequirements:
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Observability Viewer
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorSlowQueryLogs
      x-xgen-operation-id-override: listSlowQueryLogs
  "/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
        Service Account or API Key must have the Project Read Only role.
      operationId: listGroupProcessPerformanceAdvisorSuggestedIndexes
      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:
          format: int64
          type: integer
      - 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:
          items:
            type: string
          type: array
        style: form
      - description: Maximum number of example queries that benefit from the suggested
          index.
        in: query
        name: nExamples
        schema:
          default: 5
          format: int64
          type: integer
      - description: Number that indicates the maximum indexes to suggest.
        in: query
        name: nIndexes
        schema:
          format: int64
          type: integer
      - 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:
          pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$"
          type: string
      - 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:
          format: int64
          minimum: 1199145600000
          type: integer
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PerformanceAdvisorResponse"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Suggested Indexes
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor listSuggestedIndexes --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessPerformanceAdvisorSuggestedIndexesApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tListGroupProcessPerformanceAdvisorSuggestedIndexesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listGroupProcessPerformanceAdvisorSuggestedIndexes
      x-xgen-operation-id-override: listSuggestedIndexes
  "/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: listGroupProcessCollStatMeasurements
      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:
          items:
            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
            type: string
          type: array
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Host-Level Query Latency
      tags:
      - Collection Level Metrics
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api collectionLevelMetrics listProcessMeasurements --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupProcessCollStatMeasurementsApiParams{}\n\tsdkResp,
          httpResp, err := client.CollectionLevelMetricsApi.\n\t\tListGroupProcessCollStatMeasurementsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/listGroupProcessCollStatMeasurements
      x-xgen-operation-id-override: listProcessMeasurements
  "/api/atlas/v2/groups/{groupId}/pushBasedLogExport":
    delete:
      deprecated: true
      description: Disables the push-based log export feature by resetting the project
        level settings to its default configuration.
      operationId: deleteGroupPushBasedLogExport
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Disable Push-Based Log Export for One Project
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport deleteLogExport --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupPushBasedLogExportApiParams{}\n\thttpResp,
          err := client.Push - BasedLogExportApi.\n\t\tDeleteGroupPushBasedLogExportWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-02-04'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deleteGroupPushBasedLogExport
      x-xgen-operation-id-override: deleteLogExport
    get:
      deprecated: true
      description: Fetches the current project level settings for the push-based log
        export feature.
      operationId: getGroupPushBasedLogExport
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Push-Based Log Export Configuration in One Project
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport getLogExport --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupPushBasedLogExportApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tGetGroupPushBasedLogExportWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-02-04'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getGroupPushBasedLogExport
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getLogExport
    patch:
      deprecated: true
      description: Updates the project level settings for the push-based log export
        feature.
      operationId: updateGroupPushBasedLogExport
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Push-Based Log Export Configuration in One Project
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport updateLogExport --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupPushBasedLogExportApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tUpdateGroupPushBasedLogExportWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-02-04'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updateGroupPushBasedLogExport
      x-xgen-operation-id-override: updateLogExport
    post:
      deprecated: true
      description: Configures the project level settings for the push-based log export
        feature.
      operationId: createGroupPushBasedLogExport
      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/CreatePushBasedLogExportProjectRequest"
            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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Push-Based Log Export Configuration in One Project
      tags:
      - Push-Based Log Export
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api pushBasedLogExport createLogExport --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupPushBasedLogExportApiParams{}\n\tsdkResp,
          httpResp, err := client.Push - BasedLogExportApi.\n\t\tCreateGroupPushBasedLogExportWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-02-04'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createGroupPushBasedLogExport
      x-xgen-operation-id-override: createLogExport
  "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}":
    post:
      description: Requests loading the MongoDB sample dataset into the specified
        cluster. To use this resource, the requesting Service Account or API Key must
        have the Project Owner role.
      operationId: requestGroupSampleDatasetLoad
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster into which you
          load the sample dataset.
        in: path
        name: name
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '201':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/SampleDatasetStatus"
              x-xgen-version: '2023-01-01'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Load Sample Dataset into One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters requestSampleDatasetLoad --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RequestGroupSampleDatasetLoadApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tRequestGroupSampleDatasetLoadWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/requestGroupSampleDatasetLoad
      x-xgen-method-verb-override:
        customMethod: true
        verb: request
      x-xgen-operation-id-override: requestSampleDatasetLoad
  "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}":
    get:
      description: Checks the progress of loading the sample dataset into one cluster.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role.
      operationId: getGroupSampleDatasetLoad
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Unique 24-hexadecimal digit string that identifies the loaded
          sample dataset.
        in: path
        name: sampleDatasetId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/SampleDatasetStatus"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Status of Sample Dataset Load for One Cluster
      tags:
      - Clusters
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api clusters getSampleDatasetLoad --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupSampleDatasetLoadApiParams{}\n\tsdkResp,
          httpResp, err := client.ClustersApi.\n\t\tGetGroupSampleDatasetLoadWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getGroupSampleDatasetLoad
      x-xgen-operation-id-override: getSampleDatasetLoad
  "/api/atlas/v2/groups/{groupId}/serverless":
    get:
      deprecated: true
      description: |-
        Returns details for all serverless instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        This endpoint also lists Flex clusters that were created using the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or former Serverless instances that have been migrated to Flex clusters, until January 15, 2026 after which this endpoint will begin returning an empty list. The endpoint will be removed entirely on January 15, 2027. Continuous backups are not supported and `serverlessContinuousBackupEnabled` will not take effect on these clusters. Please use the List Flex Clusters endpoint instead.
      externalDocs:
        description: List Flex Clusters
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters
      operationId: listGroupServerlessInstances
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Serverless Instances in One Project
      tags:
      - Serverless Instances
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessInstances listServerlessInstances --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServerlessInstancesApiParams{}\n\tsdkResp,
          httpResp, err := client.ServerlessInstancesApi.\n\t\tListGroupServerlessInstancesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2027-01-18'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listGroupServerlessInstances
      x-xgen-method-verb-override:
        customMethod: false
        verb: listInstances
      x-xgen-operation-id-override: listServerlessInstances
  "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs":
    get:
      deprecated: true
      description: |-
        Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

        This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the List Flex Backup Restore Jobs endpoint instead.
      externalDocs:
        description: List Flex Backup Restore Jobs
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs
      operationId: listGroupServerlessBackupRestoreJobs
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Restore Jobs for One Serverless Instance
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listServerlessRestoreJobs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServerlessBackupRestoreJobsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupServerlessBackupRestoreJobsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupRestoreJobs
      x-xgen-operation-id-override: listServerlessRestoreJobs
    post:
      deprecated: true
      description: |-
        Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

        This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the Create Flex Backup Restore Job endpoint instead.
      externalDocs:
        description: Create Flex Backup Restore Job
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob
      operationId: createGroupServerlessBackupRestoreJob
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Restore Job for One Serverless Instance
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups createServerlessRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupServerlessBackupRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupServerlessBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupServerlessBackupRestoreJob
      x-xgen-operation-id-override: createServerlessRestoreJob
  "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}":
    get:
      deprecated: true
      description: |-
        Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

        This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the Get Flex Backup Restore Job endpoint instead.
      externalDocs:
        description: Get Flex Backup Restore Job
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob
      operationId: getGroupServerlessBackupRestoreJob
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the restore
          job to return.
        in: path
        name: restoreJobId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ServerlessBackupRestoreJob"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Restore Job for One Serverless Instance
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getServerlessRestoreJob --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServerlessBackupRestoreJobApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupServerlessBackupRestoreJobWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupRestoreJob
      x-xgen-operation-id-override: getServerlessRestoreJob
  "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots":
    get:
      deprecated: true
      description: |-
        Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the List Flex Backups endpoint instead.
      externalDocs:
        description: List Flex Backups
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups
      operationId: listGroupServerlessBackupSnapshots
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Snapshots of One Serverless Instance
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups listServerlessBackupSnapshots --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServerlessBackupSnapshotsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tListGroupServerlessBackupSnapshotsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupSnapshots
      x-xgen-operation-id-override: listServerlessBackupSnapshots
  "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}":
    get:
      deprecated: true
      description: |-
        Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        This endpoint can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the Get Flex Backup endpoint instead.
      externalDocs:
        description: Get Flex Backup
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup
      operationId: getGroupServerlessBackupSnapshot
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the desired
          snapshot.
        in: path
        name: snapshotId
        required: true
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ServerlessBackupSnapshot"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Snapshot of One Serverless Instance
      tags:
      - Cloud Backups
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudBackups getServerlessBackupSnapshot --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServerlessBackupSnapshotApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupServerlessBackupSnapshotWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupSnapshot
      x-xgen-operation-id-override: getServerlessBackupSnapshot
  "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing":
    get:
      deprecated: true
      description: Get whether the Serverless Auto Indexing feature is enabled. This
        endpoint returns a value for Flex clusters that were created with the Create
        Serverless Instance endpoint or Flex clusters that were migrated from Serverless
        instances. However, the value returned is not indicative of the Auto Indexing
        state as Auto Indexing is unavailable for Flex clusters. This endpoint will
        be sunset on January 22, 2026.
      externalDocs:
        description: Create Serverless Instance
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
      operationId: getGroupServerlessPerformanceAdvisorAutoIndexing
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Serverless Auto-Indexing Status
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor getServerlessAutoIndexing --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServerlessPerformanceAdvisorAutoIndexingApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tGetGroupServerlessPerformanceAdvisorAutoIndexingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getGroupServerlessPerformanceAdvisorAutoIndexing
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getServerlessAutoIndexing
    post:
      deprecated: true
      description: Set whether the Serverless Auto Indexing feature is enabled. This
        endpoint sets a value for Flex clusters that were created with the Create
        Serverless Instance endpoint or Flex clusters that were migrated from Serverless
        instances. However, the value returned is not indicative of the Auto Indexing
        state as Auto Indexing is unavailable for Flex clusters. This endpoint will
        be sunset on January 22, 2026.
      externalDocs:
        description: Create Serverless Instance
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance
      operationId: setGroupServerlessPerformanceAdvisorAutoIndexing
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Human-readable label that identifies the cluster.
        in: path
        name: clusterName
        required: true
        schema:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      - description: 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:
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Set Serverless Auto-Indexing Status
      tags:
      - Performance Advisor
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api performanceAdvisor setServerlessAutoIndexing --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.SetGroupServerlessPerformanceAdvisorAutoIndexingApiParams{}\n\tsdkResp,
          httpResp, err := client.PerformanceAdvisorApi.\n\t\tSetGroupServerlessPerformanceAdvisorAutoIndexingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2026-01-22'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setGroupServerlessPerformanceAdvisorAutoIndexing
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: set
      x-xgen-operation-id-override: setServerlessAutoIndexing
  "/api/atlas/v2/groups/{groupId}/serverless/{name}":
    get:
      deprecated: true
      description: |-
        Returns details for one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and `serverlessContinuousBackupEnabled` will not take effect on these clusters. This endpoint will be sunset on January 15, 2027. Please use the Get Flex Cluster endpoint instead.
      externalDocs:
        description: Get Flex Cluster
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster
      operationId: getGroupServerlessInstance
      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:
          pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ServerlessInstanceDescription"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Serverless Instance from One Project
      tags:
      - Serverless Instances
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serverlessInstances getServerlessInstance --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServerlessInstanceApiParams{}\n\tsdkResp,
          httpResp, err := client.ServerlessInstancesApi.\n\t\tGetGroupServerlessInstanceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-sunset: '2027-01-18'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getGroupServerlessInstance
      x-xgen-method-verb-override:
        customMethod: false
        verb: getInstance
      x-xgen-operation-id-override: getServerlessInstance
  "/api/atlas/v2/groups/{groupId}/serviceAccounts":
    get:
      description: Returns all Service Accounts for the specified Project.
      operationId: listGroupServiceAccounts
      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.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedGroupServiceAccounts"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Project Service Accounts
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts listGroupServiceAccounts --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServiceAccountsApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tListGroupServiceAccountsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listGroupServiceAccounts
    post:
      description: Creates one Service Account for the specified Project. The Service
        Account will automatically be added as an Organization Member to the Organization
        that the specified Project is a part of.
      operationId: createGroupServiceAccount
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/GroupServiceAccountRequest"
            x-xgen-version: '2024-08-05'
        description: Details of the new Service Account.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/GroupServiceAccount"
              x-xgen-version: '2024-08-05'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts createGroupServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tCreateGroupServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccount
  "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}":
    delete:
      description: Removes the specified Service Account from the specified project.
        The Service Account will still be a part of the Organization it was created
        in, and the credentials will remain active until expired or manually revoked.
      operationId: deleteGroupServiceAccount
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
          x-xgen-version: '2024-08-05'
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts deleteGroupServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupServiceAccountApiParams{}\n\thttpResp,
          err := client.ServiceAccountsApi.\n\t\tDeleteGroupServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccount
    get:
      description: Returns one Service Account in the specified Project.
      operationId: getGroupServiceAccount
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/GroupServiceAccount"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts getGroupServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tGetGroupServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getGroupServiceAccount
    patch:
      description: Updates one Service Account in the specified Project.
      operationId: updateGroupServiceAccount
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/GroupServiceAccountUpdateRequest"
        description: The new details for the Service Account.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/GroupServiceAccount"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts updateGroupServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tUpdateGroupServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateGroupServiceAccount
  "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList":
    get:
      description: Returns all access list entries that you configured for the specified
        Service Account for the project.
      operationId: listGroupServiceAccountAccessList
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedServiceAccountIPAccessEntryView"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Access List Entries for One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts listAccessList --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServiceAccountAccessListApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tListGroupServiceAccountAccessListWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listGroupServiceAccountAccessList
      x-xgen-operation-id-override: listAccessList
    post:
      description: Add Access List Entries for the specified Service Account for the
        project. Resources require all API requests to originate from IP addresses
        on the API access list. To use this resource, the requesting Service Account
        or API Key must have the Project Owner role or Project Access Manager role.
      operationId: createGroupServiceAccountAccessList
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/includeCount"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              items:
                "$ref": "#/components/schemas/ServiceAccountIPAccessListEntry"
              maxItems: 200
              type: array
            x-xgen-version: '2024-08-05'
        description: A list of access list entries to add to the access list of the
          specified Service Account for the project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedServiceAccountIPAccessEntryView"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add Access List Entries for One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts createAccessList --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupServiceAccountAccessListApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tCreateGroupServiceAccountAccessListWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccountAccessList
      x-xgen-operation-id-override: createAccessList
  "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}":
    delete:
      description: Removes the specified access list entry from the specified Service
        Account for the project. You can't remove the requesting IP address from the
        access list. To use this resource, the requesting Service Account or API Key
        must have the Project Owner role or Project Access Manager role.
      operationId: deleteGroupServiceAccountAccessListEntry
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - description: One IP address or multiple IP addresses represented as one CIDR
          block. When specifying 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:
          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})?$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Access List Entry from One Project Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts deleteGroupAccessEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupServiceAccountAccessListEntryApiParams{}\n\thttpResp,
          err := client.ServiceAccountsApi.\n\t\tDeleteGroupServiceAccountAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}"
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccountAccessListEntry
      x-xgen-method-verb-override:
        customMethod: false
        verb: deleteEntry
      x-xgen-operation-id-override: deleteGroupAccessEntry
  "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets":
    post:
      description: Create a secret for the specified Service Account in the specified
        Project.
      operationId: createGroupServiceAccountSecret
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ServiceAccountSecretRequest"
        description: Details for the new secret.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ServiceAccountSecret"
              x-xgen-version: '2024-08-05'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Project Service Account Secret
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts createGroupSecret --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupServiceAccountSecretApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tCreateGroupServiceAccountSecretWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createGroupServiceAccountSecret
      x-xgen-operation-id-override: createGroupSecret
  "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}":
    delete:
      description: Deletes the specified Service Account secret.
      operationId: deleteGroupServiceAccountSecret
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the secret.
        in: path
        name: secretId
        required: true
        schema:
          type: string
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Project Service Account Secret
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts deleteGroupSecret --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupServiceAccountSecretApiParams{}\n\thttpResp,
          err := client.ServiceAccountsApi.\n\t\tDeleteGroupServiceAccountSecretWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteGroupServiceAccountSecret
      x-xgen-operation-id-override: deleteGroupSecret
  "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite":
    post:
      description: Assigns the specified Service Account to the specified Project.
      operationId: inviteGroupServiceAccount
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/GroupServiceAccountRoleAssignment"
            x-xgen-version: '2024-08-05'
        description: The Project permissions for the Service Account in the specified
          Project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/GroupServiceAccount"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Assign One Service Account to One Project
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts inviteGroupServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.InviteGroupServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tInviteGroupServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/inviteGroupServiceAccount
  "/api/atlas/v2/groups/{groupId}/settings":
    get:
      description: Returns details about the specified project's settings. To use
        this resource, the requesting Service Account or API Key must have the Project
        Read Only role.
      operationId: getGroupSettings
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Project Settings
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects getGroupSettings --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupSettingsApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tGetGroupSettingsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getGroupSettings
    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 Service Account or API
        Key must have the Project Owner role.
      operationId: updateGroupSettings
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Project Settings
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects updateGroupSettings --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupSettingsApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tUpdateGroupSettingsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupSettings
  "/api/atlas/v2/groups/{groupId}/streams":
    get:
      description: Returns all stream workspaces for the specified project.
      operationId: listGroupStreamWorkspaces
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Stream Workspaces in One Project
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams listStreamWorkspaces --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupStreamWorkspacesApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tListGroupStreamWorkspacesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamWorkspaces
      x-xgen-method-verb-override:
        customMethod: false
        verb: listWorkspaces
      x-xgen-operation-id-override: listStreamWorkspaces
    post:
      description: Creates one stream workspace in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Data Access Admin role, Project Owner role or Project Stream Processing Owner
        role.
      operationId: createGroupStreamWorkspace
      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 workspace 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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Stream Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams createStreamWorkspace --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupStreamWorkspaceApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tCreateGroupStreamWorkspaceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamWorkspace
      x-xgen-method-verb-override:
        customMethod: false
        verb: createWorkspace
      x-xgen-operation-id-override: createStreamWorkspace
  "/api/atlas/v2/groups/{groupId}/streams/accountDetails":
    get:
      description: Returns the Account ID, and the VPC ID for the group and region
        specified.
      operationId: getGroupStreamAccountDetails
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - description: One of "aws", "azure" or "gcp".
        in: query
        name: cloudProvider
        required: true
        schema:
          type: string
      - description: The cloud provider specific region name, i.e. "US_EAST_1" for
          cloud provider "aws".
        in: query
        name: regionName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/AccountDetails"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Account ID and VPC ID for One Project and Region
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams getAccountDetails --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupStreamAccountDetailsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tGetGroupStreamAccountDetailsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/accountDetails?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/accountDetails?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamAccountDetails
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getAccountDetails
  "/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections":
    get:
      description: Returns a list of active incoming VPC Peering Connections.
      operationId: listGroupStreamActiveVpcPeeringConnections
      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.2024-11-13+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiStreamsVPCPeeringConnectionView"
              x-xgen-version: '2024-11-13'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Active Incoming VPC Peering Connections
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams listActivePeeringConnections --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupStreamActiveVpcPeeringConnectionsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tListGroupStreamActiveVpcPeeringConnectionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamActiveVpcPeeringConnections
      x-xgen-operation-id-override: listActivePeeringConnections
  "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections":
    get:
      description: Returns all Private Link connections for the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role, Project Data Access roles, Project Owner role
        or Project Stream Processing Owner role.
      operationId: listGroupStreamPrivateLinkConnections
      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/PaginatedApiStreamsPrivateLinkView"
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Private Link Connections
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams listPrivateLinkConnections --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupStreamPrivateLinkConnectionsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tListGroupStreamPrivateLinkConnectionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-changelog:
        '2024-10-02': The MongoDB Atlas Streams Processing Private Link API is now
          exposed as part of private preview, but is subject to change until GA.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamPrivateLinkConnections
      x-xgen-operation-id-override: listPrivateLinkConnections
    post:
      description: Creates one Private Link in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Owner or Project Stream Processing Owner role.
      operationId: createGroupStreamPrivateLinkConnection
      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/StreamsPrivateLinkConnection"
        description: Details to create one Private Link connection for a project.
          project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                "$ref": "#/components/schemas/StreamsPrivateLinkConnection"
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/unauthorized"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Private Link Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams createPrivateLinkConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupStreamPrivateLinkConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tCreateGroupStreamPrivateLinkConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-changelog:
        '2024-10-02': The MongoDB Atlas Streams Processing Private Link API is now
          exposed as part of private preview, but is subject to change until GA.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamPrivateLinkConnection
      x-xgen-operation-id-override: createPrivateLinkConnection
  "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}":
    delete:
      description: Deletes one Private Link in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Owner or Project Stream Processing Owner role.
      operationId: deleteGroupStreamPrivateLinkConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Unique ID that identifies the Private Link connection.
        in: path
        name: connectionId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Private Link Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams deletePrivateLinkConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupStreamPrivateLinkConnectionApiParams{}\n\thttpResp,
          err := client.StreamsApi.\n\t\tDeleteGroupStreamPrivateLinkConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-changelog:
        '2024-10-02': The MongoDB Atlas Streams Processing Private Link API is now
          exposed as part of private preview, but is subject to change until GA.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamPrivateLinkConnection
      x-xgen-operation-id-override: deletePrivateLinkConnection
    get:
      description: Returns the details of one Private Link connection within the project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Read Only role.
      operationId: getGroupStreamPrivateLinkConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Unique ID that identifies the Private Link connection.
        in: path
        name: connectionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-02-01+json:
              schema:
                "$ref": "#/components/schemas/StreamsPrivateLinkConnection"
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Private Link Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams getPrivateLinkConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupStreamPrivateLinkConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tGetGroupStreamPrivateLinkConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-changelog:
        '2024-10-02': The MongoDB Atlas Streams Processing Private Link API is now
          exposed as part of private preview, but is subject to change until GA.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamPrivateLinkConnection
      x-xgen-operation-id-override: getPrivateLinkConnection
  "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections":
    get:
      description: Returns a list of incoming VPC Peering Connections.
      operationId: listGroupStreamVpcPeeringConnections
      parameters:
      - description: The Account ID of the VPC Peering connection/s.
        in: query
        name: requesterAccountId
        required: true
        schema:
          type: string
      - "$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/PaginatedApiStreamsVPCPeeringConnectionView"
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All VPC Peering Connections
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams listVpcPeeringConnections --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupStreamVpcPeeringConnectionsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tListGroupStreamVpcPeeringConnectionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamVpcPeeringConnections
      x-xgen-operation-id-override: listVpcPeeringConnections
  "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}":
    delete:
      description: Deletes an incoming VPC Peering connection.
      operationId: deleteGroupStreamVpcPeeringConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: The VPC Peering Connection id.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One VPC Peering Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams deleteVpcPeeringConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupStreamVpcPeeringConnectionApiParams{}\n\thttpResp,
          err := client.StreamsApi.\n\t\tDeleteGroupStreamVpcPeeringConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamVpcPeeringConnection
      x-xgen-operation-id-override: deleteVpcPeeringConnection
  "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept":
    post:
      description: Requests the acceptance of an incoming VPC Peering connection.
      operationId: acceptGroupStreamVpcPeeringConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: The VPC Peering Connection id.
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              "$ref": "#/components/schemas/VPCPeeringActionChallenge"
        description: Challenge values for VPC Peering requester account ID, and requester
          VPC ID.
        required: true
      responses:
        '202':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Accept One Incoming VPC Peering Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams acceptVpcPeeringConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AcceptGroupStreamVpcPeeringConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tAcceptGroupStreamVpcPeeringConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptGroupStreamVpcPeeringConnection
      x-xgen-operation-id-override: acceptVpcPeeringConnection
  "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject":
    post:
      description: Requests the rejection of an incoming VPC Peering connection.
      operationId: rejectGroupStreamVpcPeeringConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: The VPC Peering Connection id.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Reject One Incoming VPC Peering Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams rejectVpcPeeringConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RejectGroupStreamVpcPeeringConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tRejectGroupStreamVpcPeeringConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectGroupStreamVpcPeeringConnection
      x-xgen-operation-id-override: rejectVpcPeeringConnection
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}":
    delete:
      description: Delete one stream workspace in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Data Access Admin role, Project Owner role or Project Stream Processing Owner
        role.
      operationId: deleteGroupStreamWorkspace
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace to delete.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.atlas.2023-02-01+json:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Stream Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams deleteStreamWorkspace --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupStreamWorkspaceApiParams{}\n\thttpResp,
          err := client.StreamsApi.\n\t\tDeleteGroupStreamWorkspaceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamWorkspace
      x-xgen-method-verb-override:
        customMethod: false
        verb: deleteWorkspace
      x-xgen-operation-id-override: deleteStreamWorkspace
    get:
      description: Returns the details of one stream workspace within the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Data Access roles, Project Owner role or Project Stream Processing
        Owner role.
      operationId: getGroupStreamWorkspace
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace to return.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Flag to indicate whether connections information should be included
          in the stream workspace.
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Stream Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams getStreamWorkspace --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupStreamWorkspaceApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tGetGroupStreamWorkspaceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamWorkspace
      x-xgen-method-verb-override:
        customMethod: false
        verb: getWorkspace
      x-xgen-operation-id-override: getStreamWorkspace
    patch:
      description: Update one stream workspace in the specified project. To use this
        resource, the requesting Service Account or API Key must have the Project
        Data Access Admin role, Project Owner role or Project Stream Processing Owner
        role.
      operationId: updateGroupStreamWorkspace
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace to update.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-02-01+json:
            schema:
              "$ref": "#/components/schemas/StreamsTenantUpdateRequest"
        description: Details to update in the streams workspace.
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Stream Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams updateStreamWorkspace --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupStreamWorkspaceApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tUpdateGroupStreamWorkspaceWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamWorkspace
      x-xgen-method-verb-override:
        customMethod: false
        verb: updateWorkspace
      x-xgen-operation-id-override: updateStreamWorkspace
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs":
    get:
      description: 'Downloads the audit logs for the specified Atlas Streams Processing
        workspace or stream processor. By default, logs cover periods of 30 days.
        To use this resource, the requesting Service Account or API Key must have
        the Project Data Access roles, Project Owner role or Project Stream Processing
        Owner role. The API does not support direct calls with the json response schema.
        You must request a gzip response schema using an accept header of the format:
        `Accept: application/vnd.atlas.YYYY-MM-DD+gzip`.'
      operationId: downloadGroupStreamAuditLogs
      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:
          example: 1636481348
          format: int64
          pattern: '1199145600'
          type: integer
      - 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:
          example: 1636466948
          format: int64
          pattern: '1199145600'
          type: integer
      - description: Name of the stream processor to download logs for. An empty string
          will download logs for all stream processors in the workspace.
        in: query
        name: spName
        schema:
          type: string
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-02-01+gzip:
              schema:
                description: Compressed archive containing `[tenantName]_[spName]_[startTime]_[endTime]_audit.log`
                  downloads
                format: binary
                type: string
              x-xgen-version: '2023-02-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Download Audit Logs for One Atlas Stream Processing Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams downloadAuditLogs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DownloadGroupStreamAuditLogsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tDownloadGroupStreamAuditLogsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs" \
            --output "file_name.gz"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs" \
            --output "file_name.gz"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadGroupStreamAuditLogs
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: download
      x-xgen-operation-id-override: downloadAuditLogs
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections":
    get:
      description: Returns all connections of the stream workspace for the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Data Access roles, Project Owner role or Project Stream Processing
        Owner role.
      operationId: listGroupStreamConnections
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - description: Label that identifies the stream workspace.
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Connections of the Stream Workspaces
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams listStreamConnections --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupStreamConnectionsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tListGroupStreamConnectionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listGroupStreamConnections
      x-xgen-operation-id-override: listStreamConnections
    post:
      description: Creates one connection for a stream workspace in the specified
        project. To use this resource, the requesting Service Account or API Key must
        have the Project Owner or Project Stream Processing Owner role.
      operationId: createGroupStreamConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        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 workspace 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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/unauthorized"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Stream Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams createStreamConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupStreamConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tCreateGroupStreamConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamConnection
      x-xgen-operation-id-override: createStreamConnection
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}":
    delete:
      description: Delete one connection of the specified stream workspace. To use
        this resource, the requesting Service Account or API Key must have the Project
        Owner role or Project Stream Processing Owner role.
      operationId: deleteGroupStreamConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: 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:
              x-xgen-version: '2023-02-01'
          description: Accepted
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Stream Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams deleteStreamConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupStreamConnectionApiParams{}\n\thttpResp,
          err := client.StreamsApi.\n\t\tDeleteGroupStreamConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamConnection
      x-xgen-operation-id-override: deleteStreamConnection
    get:
      description: Returns the details of one stream connection within the specified
        stream workspace. To use this resource, the requesting Service Account or
        API Key must have the Project Read Only role.
      operationId: getGroupStreamConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace to return.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: 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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Stream Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams getStreamConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupStreamConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tGetGroupStreamConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamConnection
      x-xgen-operation-id-override: getStreamConnection
    patch:
      description: Update one connection for the specified stream workspace in the
        specified project. To use this resource, the requesting Service Account or
        API Key must have the Project Owner role or Project Stream Processing Owner
        role.
      operationId: updateGroupStreamConnection
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: 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 workspace 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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Stream Connection
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams updateStreamConnection --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupStreamConnectionApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tUpdateGroupStreamConnectionWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      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.
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamConnection
      x-xgen-operation-id-override: updateStreamConnection
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor":
    post:
      description: Create one Stream Processor within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: createGroupStreamProcessor
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/StreamsProcessor"
        description: Details to create an Atlas Streams Processor.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/StreamsProcessor"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/unauthorized"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Stream Processor
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams createStreamProcessor --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupStreamProcessorApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tCreateGroupStreamProcessorWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createGroupStreamProcessor
      x-xgen-operation-id-override: createStreamProcessor
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}":
    delete:
      description: Delete a Stream Processor within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: deleteGroupStreamProcessor
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Label that identifies the stream processor.
        in: path
        name: processorName
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Stream Processor
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams deleteStreamProcessor --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupStreamProcessorApiParams{}\n\thttpResp,
          err := client.StreamsApi.\n\t\tDeleteGroupStreamProcessorWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteGroupStreamProcessor
      x-xgen-operation-id-override: deleteStreamProcessor
    get:
      description: Get one Stream Processor within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: getGroupStreamProcessor
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Label that identifies the stream processor.
        in: path
        name: processorName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/StreamsProcessorWithStats"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Stream Processor
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams getStreamProcessor --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupStreamProcessorApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tGetGroupStreamProcessorWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamProcessor
      x-xgen-operation-id-override: getStreamProcessor
    patch:
      description: Modify one existing Stream Processor within the specified stream
        workspace. To use this resource, the requesting Service Account or API Key
        must have the Project Owner role or Project Stream Processing Owner role.
      operationId: updateGroupStreamProcessor
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Label that identifies the stream processor.
        in: path
        name: processorName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/StreamsModifyStreamProcessor"
        description: Modifications to apply to the stream processor.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/StreamsProcessorWithStats"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Stream Processor
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams updateStreamProcessor --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupStreamProcessorApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tUpdateGroupStreamProcessorWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateGroupStreamProcessor
      x-xgen-operation-id-override: updateStreamProcessor
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start":
    post:
      description: Start a Stream Processor within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: startGroupStreamProcessor
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Label that identifies the stream processor.
        in: path
        name: processorName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Start One Stream Processor
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams startStreamProcessor --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.StartGroupStreamProcessorApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tStartGroupStreamProcessorWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startGroupStreamProcessor
      x-xgen-operation-id-override: startStreamProcessor
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith":
    post:
      description: Start a Stream Processor within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: startGroupStreamProcessorWith
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Label that identifies the stream processor.
        in: path
        name: processorName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-03-12+json:
            schema:
              "$ref": "#/components/schemas/StreamsStartStreamProcessorWith"
            x-xgen-version: '2025-03-12'
        description: Options for starting a stream processor.
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Start One Stream Processor With Options
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams startStreamProcessorWith --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.StartGroupStreamProcessorWithApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tStartGroupStreamProcessorWithWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startGroupStreamProcessorWith
      x-xgen-operation-id-override: startStreamProcessorWith
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop":
    post:
      description: Stop a Stream Processor within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: stopGroupStreamProcessor
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      - description: Label that identifies the stream processor.
        in: path
        name: processorName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Stop One Stream Processor
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams stopStreamProcessor --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.StopGroupStreamProcessorApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tStopGroupStreamProcessorWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopGroupStreamProcessor
      x-xgen-operation-id-override: stopStreamProcessor
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors":
    get:
      description: Returns all Stream Processors within the specified stream workspace.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role or Project Stream Processing Owner role.
      operationId: getGroupStreamProcessors
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/includeCount"
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Stream Processors in One Stream Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams getStreamProcessors --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupStreamProcessorsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tGetGroupStreamProcessorsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getGroupStreamProcessors
      x-xgen-operation-id-override: getStreamProcessors
  "/api/atlas/v2/groups/{groupId}/streams/{tenantName}:downloadOperationalLogs":
    get:
      description: 'Downloads the operational logs for the specified Atlas Streams
        Processing workspace or stream processor. By default, logs cover periods of
        30 days. To use this resource, the requesting Service Account or API Key must
        have the Project Data Access roles, Project Owner role or Project Stream Processing
        Owner role. The API does not support direct calls with the json response schema.
        You must request a gzip response schema using an accept header of the format:
        "Accept: application/vnd.atlas.2025-03-12+gzip".'
      operationId: downloadGroupStreamOperationalLogs
      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:
          example: 1636481348
          format: int64
          pattern: '1199145600'
          type: integer
      - 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:
          example: 1636466948
          format: int64
          pattern: '1199145600'
          type: integer
      - description: Name of the stream processor to download logs for. An empty string
          will download logs for all stream processors in the workspace.
        in: query
        name: spName
        schema:
          type: string
      - description: Label that identifies the stream workspace.
        in: path
        name: tenantName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+gzip:
              schema:
                description: Compressed archive labeled `[tenantName]_[spName]_[startTime]_[endTime]_queries.gz`
                  downloads
                format: binary
                readOnly: true
                type: string
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Download Operational Logs for One Atlas Stream Processing Workspace
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams downloadOperationalLogs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DownloadGroupStreamOperationalLogsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tDownloadGroupStreamOperationalLogsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}:downloadOperationalLogs" \
            --output "file_name.gz"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+gzip" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}:downloadOperationalLogs" \
            --output "file_name.gz"
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Data Access Read Only
      - Project Data Access Read Write
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadGroupStreamOperationalLogs
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: download
      x-xgen-operation-id-override: downloadOperationalLogs
  "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections":
    post:
      description: Creates one stream workspace in the specified project with sample
        connections. To use this resource the requesting Service Account or API Key
        must have the Project Data Access Admin role, Project Owner role or Project
        Stream Processing Owner role.
      operationId: withGroupStreamSampleConnections
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/TenantWithSampleConnections"
        description: Details to create one streams workspace in the specified project.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/StreamsTenant"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Stream Workspace with Sample Connections
      tags:
      - Streams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api streams withStreamSampleConnections --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.WithGroupStreamSampleConnectionsApiParams{}\n\tsdkResp,
          httpResp, err := client.StreamsApi.\n\t\tWithGroupStreamSampleConnectionsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Stream Processing Admin
      - Project Data Access Admin
      - Project Stream Processing Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/withGroupStreamSampleConnections
      x-xgen-operation-id-override: withStreamSampleConnections
  "/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 Service Account or API Key must have the Project Read Only role.
      operationId: listGroupTeams
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Teams in One Project
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams listGroupTeams --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupTeamsApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tListGroupTeamsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listGroupTeams
    post:
      description: Adds multiple teams to the specified project. All members of a
        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 Service Account or API Key must have
        the Project Owner role or Project Access Manager role.
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: addGroupTeams
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/groupId"
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              items:
                "$ref": "#/components/schemas/TeamRole"
              type: array
        description: Teams and their roles to be added 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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add Multiple Teams to One Project
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams addGroupTeams --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddGroupTeamsApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tAddGroupTeamsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addGroupTeams
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: add
  "/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 Service Account or API Key
        must have the Project Owner role or Project Access Manager role.
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: removeGroupTeam
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Team from One Project
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams removeGroupTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveGroupTeamApiParams{}\n\thttpResp,
          err := client.TeamsApi.\n\t\tRemoveGroupTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}"
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeGroupTeam
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: remove
    get:
      description: Returns one team 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 Service Account or API Key must have the Project Read Only role.
      operationId: getGroupTeam
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - description: Unique 24-hexadecimal digit string that identifies the team for
          which you want to get.
        in: path
        name: teamId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/TeamRole"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Team in One Project
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams getGroupTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupTeamApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tGetGroupTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getGroupTeam
    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 Service Account or API Key must have the Project
        Owner role or Project Access Manager role.
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: updateGroupTeam
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Team Roles in One Project
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams updateGroupTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupTeamApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tUpdateGroupTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateGroupTeam
  "/api/atlas/v2/groups/{groupId}/userSecurity":
    get:
      description: Returns the current LDAP configuration for the specified project.
        To use this resource, the requesting Service Account or API Key must have
        the Project Owner role.
      operationId: getGroupUserSecurity
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return LDAP or X.509 Configuration
      tags:
      - LDAP Configuration
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api ldapConfiguration getUserSecurity --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupUserSecurityApiParams{}\n\tsdkResp,
          httpResp, err := client.LDAPConfigurationApi.\n\t\tGetGroupUserSecurityWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getGroupUserSecurity
      x-xgen-operation-id-override: getUserSecurity
    patch:
      description: |-
        Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

        Updating this configuration triggers a rolling restart of the database.
      operationId: updateGroupUserSecurity
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update LDAP or X.509 Configuration
      tags:
      - LDAP Configuration
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api ldapConfiguration updateUserSecurity --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupUserSecurityApiParams{}\n\tsdkResp,
          httpResp, err := client.LDAPConfigurationApi.\n\t\tUpdateGroupUserSecurityWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/updateGroupUserSecurity
      x-xgen-operation-id-override: updateUserSecurity
  "/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: disableGroupUserSecurityCustomerX509
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Disable Customer-Managed X.509
      tags:
      - X.509 Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api x509Authentication disableSecurityCustomerX509 --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DisableGroupUserSecurityCustomerX509ApiParams{}\n\thttpResp,
          err := client.X509AuthenticationApi.\n\t\tDisableGroupUserSecurityCustomerX509WithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableGroupUserSecurityCustomerX509
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: disable
      x-xgen-operation-id-override: disableSecurityCustomerX509
  "/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 Service Account or API Key must
        have the Project Owner role.
      operationId: deleteGroupUserSecurityLdapUserToDnMapping
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove LDAP User to DN Mapping
      tags:
      - LDAP Configuration
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api ldapConfiguration deleteLdapUserMapping --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupUserSecurityLdapUserToDnMappingApiParams{}\n\thttpResp,
          err := client.LDAPConfigurationApi.\n\t\tDeleteGroupUserSecurityLdapUserToDnMappingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteGroupUserSecurityLdapUserToDnMapping
      x-xgen-operation-id-override: deleteLdapUserMapping
  "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify":
    post:
      description: Verifies the LDAP configuration for the specified project. To use
        this resource, the requesting Service Account or API Key must have the Project
        Owner role.
      operationId: verifyGroupUserSecurityLdap
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Verify LDAP Configuration in One Project
      tags:
      - LDAP Configuration
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api ldapConfiguration verifyUserSecurityLdap --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.VerifyGroupUserSecurityLdapApiParams{}\n\tsdkResp,
          httpResp, err := client.LDAPConfigurationApi.\n\t\tVerifyGroupUserSecurityLdapWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyGroupUserSecurityLdap
      x-xgen-method-verb-override:
        customMethod: 'True'
      x-xgen-operation-id-override: verifyUserSecurityLdap
  "/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 Service Account
        or API Key must have the Project Owner role.
      operationId: getGroupUserSecurityLdapVerify
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique string that identifies the request to verify an Lightweight
          Directory Access Protocol (LDAP) configuration.
        in: path
        name: requestId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequest"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Status of LDAP Configuration Verification in One Project
      tags:
      - LDAP Configuration
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api ldapConfiguration getUserSecurityVerify --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupUserSecurityLdapVerifyApiParams{}\n\tsdkResp,
          httpResp, err := client.LDAPConfigurationApi.\n\t\tGetGroupUserSecurityLdapVerifyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true"
      x-rolesRequirements:
      - Project Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getGroupUserSecurityLdapVerify
      x-xgen-method-verb-override:
        customMethod: false
        verb: get
      x-xgen-operation-id-override: getUserSecurityVerify
  "/api/atlas/v2/groups/{groupId}/users":
    get:
      description: |-
        Returns details about the pending and active MongoDB Cloud users associated with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        **Note**: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

        **Note**: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: listGroupUsers
      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:
          default: false
          type: boolean
      - 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:
          default: false
          type: boolean
      - description: Flag that indicates whether to filter the returned list by users
          organization membership status. If you exclude this parameter, this resource
          returns both pending and active users. Not supported in deprecated versions.
        in: query
        name: orgMembershipStatus
        schema:
          example: ACTIVE
          type: string
      - description: Email address to filter users by. Not supported in deprecated
          versions.
        in: query
        name: username
        schema:
          format: email
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/PaginatedGroupUserView"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All MongoDB Cloud Users in One Project
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers listGroupUsers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupUsersApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tListGroupUsersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listGroupUsers
    post:
      description: "Adds one MongoDB Cloud user to one project. To use this resource,
        the requesting Service Account or API Key must have the Project Owner role
        or Project Access Manager role. \n- If the user has a pending invitation to
        join the project's organization, MongoDB Cloud modifies it and grants project
        access. \n- If the user doesn't have an invitation to join the organization,
        MongoDB Cloud sends a new invitation that grants the user organization and
        project access. \n- If the user is already active in the project's organization,
        MongoDB Cloud grants access to the project. \n"
      operationId: addGroupUsers
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/GroupUserRequest"
        description: The active or pending MongoDB Cloud user that you want to add
          to the specified project.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/GroupUserResponse"
              x-xgen-version: '2025-02-19'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One MongoDB Cloud User to One Project
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers addGroupUsers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddGroupUsersApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tAddGroupUsersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addGroupUsers
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: add
  "/api/atlas/v2/groups/{groupId}/users/{userId}":
    delete:
      description: |-
        Removes one MongoDB Cloud user from the specified project. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Access Manager role.

        **Note**: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

        **Note**: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: removeGroupUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the project. If you need to lookup a user's `userId` or
          verify a user's status in the organization, use the [Return All MongoDB
          Cloud Users in One Project](#tag/MongoDB-Cloud-Users/operation/listProjectUsers)
          resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2025-02-19+json:
              x-xgen-version: '2025-02-19'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One MongoDB Cloud User from One Project
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers removeGroupUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveGroupUserApiParams{}\n\thttpResp,
          err := client.MongoDBCloudUsersApi.\n\t\tRemoveGroupUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}"
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeGroupUser
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: remove
    get:
      description: |-
        Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

        **Note**: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.

        **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
      operationId: getGroupUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the project. If you need to lookup a user's `userId` or
          verify a user's status in the organization, use the Return All MongoDB Cloud
          Users in One Project resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/GroupUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One MongoDB Cloud User in One Project
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers getGroupUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tGetGroupUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}?pretty=true"
      x-rolesRequirements:
      - Project Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getGroupUser
  "/api/atlas/v2/groups/{groupId}/users/{userId}/roles":
    put:
      deprecated: true
      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 Service Account or API Key must have the Group User Admin role.
      operationId: updateGroupUserRoles
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - description: Unique 24-hexadecimal digit string that identifies the user to
          modify.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Project Roles for One MongoDB Cloud User
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects updateGroupUserRoles --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupUserRolesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tUpdateGroupUserRolesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateGroupUserRoles
  "/api/atlas/v2/groups/{groupId}/users/{userId}:addRole":
    post:
      description: |-
        Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Access Manager role.

        **Note**: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: addGroupUserRole
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the project. If you need to lookup a user's `userId` or
          verify a user's status in the organization, use the Return All MongoDB Cloud
          Users in One Project resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/AddOrRemoveGroupRole"
        description: Project-level role to assign to the MongoDB Cloud user.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/GroupUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One Project Role to One MongoDB Cloud User
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers addGroupUserRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddGroupUserRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tAddGroupUserRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}:addRole" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}:addRole" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addGroupUserRole
  "/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole":
    post:
      description: |-
        Removes one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Access Manager role.

        **Note**: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: removeGroupUserRole
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the project. If you need to lookup a user's `userId` or
          verify a user's status in the organization, use the Return All MongoDB Cloud
          Users in One Project resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/AddOrRemoveGroupRole"
        description: Project-level role to remove from the MongoDB Cloud user.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/GroupUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Project Role from One MongoDB Cloud User
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers removeGroupUserRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveGroupUserRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tRemoveGroupUserRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Project Access Manager
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeGroupUserRole
  "/api/atlas/v2/groups/{groupId}:migrate":
    post:
      description: Migrates a project from its current organization to another organization.
        All project users and their roles will be copied to the same project in the
        destination organization. You must include an organization API key with the
        Organization Owner role for the destination organization to verify access
        to the destination organization when you authenticate with Programmatic API
        Keys. Otherwise, the requesting user must have the Organization Owner role
        in both organizations. To use this resource, the requesting Service Account
        or API Key must have the Organization Owner role.
      operationId: migrateGroup
      parameters:
      - "$ref": "#/components/parameters/groupId"
      - "$ref": "#/components/parameters/envelope"
      requestBody:
        content:
          application/vnd.atlas.2024-05-30+json:
            schema:
              "$ref": "#/components/schemas/GroupMigrationRequest"
        description: Migrates a project from its current organization to another organization.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-05-30+json:
              schema:
                "$ref": "#/components/schemas/Group"
              x-xgen-version: '2024-05-30'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Migrate One Project to Another Organization
      tags:
      - Projects
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api projects migrateGroup --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.MigrateGroupApiParams{}\n\tsdkResp,
          httpResp, err := client.ProjectsApi.\n\t\tMigrateGroupWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateGroup
  "/api/atlas/v2/orgs":
    get:
      description: Returns all organizations to which the requesting Service Account
        or API Key has access. To use this resource, the requesting Service Account
        or API Key must have the Organization Member role.
      operationId: listOrgs
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Organizations
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations listOrgs --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgsApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tListOrgsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrgs
    post:
      description: Creates one organization in MongoDB Cloud and links it to the requesting
        Service Account's or API Key's organization. To use this resource, the requesting
        Service Account or API Key must have the Organization Owner role. The requesting
        Service Account's or API Key's organization must be a paying organization.
        To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation.
        Optionally, if `federationSettingsId` is provided, the new Organization will
        be linked to the federation. The requesting Service Account or API Key must
        be an Organization Owner in the federation.
      externalDocs:
        description: Configure a Paying Organization
        url: https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization
      operationId: createOrg
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations createOrg --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tCreateOrgWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \
            -d '{ <Payload> }'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrg
  "/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 Service Account or API Key must have the Organization Owner role.
      operationId: deleteOrg
      parameters:
      - "$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: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '402':
          "$ref": "#/components/responses/paymentRequired"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations deleteOrg --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgApiParams{}\n\thttpResp,
          err := client.OrganizationsApi.\n\t\tDeleteOrgWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrg
    get:
      description: Returns one organization to which the requesting Service Account
        or API Key has access. To use this resource, the requesting Service Account
        or API Key must have the Organization Member role.
      operationId: getOrg
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations getOrg --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tGetOrgWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrg
    patch:
      description: Updates one organization. To use this resource, the requesting
        Service Account or API Key must have the Organization Owner role.
      operationId: updateOrg
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations updateOrg --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tUpdateOrgWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrg
  "/api/atlas/v2/orgs/{orgId}/activityFeed":
    get:
      description: Returns a pre-filtered activity feed link for the specified organization
        based on the provided date range and event types. The returned link can be
        shared and opened to view the activity feed with the same filters applied.
        To use this resource, the requesting Service Account or API Key must have
        the Organization Member role.
      operationId: getOrgActivityFeed
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - "$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:
          description: List of event types to filter the activity feed.
          externalDocs:
            description: Event Types
            url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/
          items:
            "$ref": "#/components/schemas/EventTypeForOrg"
          maxItems: 20
          type: array
      - description: End date and time for events to include in the activity feed
          link. ISO 8601 timestamp format in UTC.
        in: query
        name: maxDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      - description: Start date and time for events to include in the activity feed
          link. ISO 8601 timestamp format in UTC.
        in: query
        name: minDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/ActivityFeedLinkResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Pre-Filtered Activity Feed Link for One Organization
      tags:
      - Activity Feed
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api activityFeed getOrgActivityFeed --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgActivityFeedApiParams{}\n\tsdkResp,
          httpResp, err := client.ActivityFeedApi.\n\t\tGetOrgActivityFeedWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/activityFeed?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/activityFeed?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Activity-Feed/operation/getOrgActivityFeed
  "/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 Service Account or 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: listOrgApiKeys
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Organization API Keys
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys listOrgApiKeys --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgApiKeysApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tListOrgApiKeysWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listOrgApiKeys
    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 Service
        Account or 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: createOrgApiKey
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys createOrgApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgApiKeyApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tCreateOrgApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createOrgApiKey
  "/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
        Service Account or 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: deleteOrgApiKey
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys deleteOrgApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgApiKeyApiParams{}\n\thttpResp,
          err := client.ProgrammaticAPIKeysApi.\n\t\tDeleteOrgApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteOrgApiKey
    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
        Service Account or 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: getOrgApiKey
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/ApiKeyUserDetails"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys getOrgApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgApiKeyApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tGetOrgApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getOrgApiKey
    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: updateOrgApiKey
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys updateOrgApiKey --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgApiKeyApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tUpdateOrgApiKeyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateOrgApiKey
  "/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 Service Account
        or 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: listOrgApiKeyAccessListEntries
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiUserAccessListResponseView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Access List Entries for One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys listOrgAccessEntries --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgApiKeyAccessListEntriesApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tListOrgApiKeyAccessListEntriesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listOrgApiKeyAccessListEntries
      x-xgen-method-verb-override:
        customMethod: false
        verb: listEntries
      x-xgen-operation-id-override: listOrgAccessEntries
    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 Service Account
        or API Key must have the Read Write role.
      operationId: createOrgApiKeyAccessListEntry
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              items:
                "$ref": "#/components/schemas/UserAccessListRequest"
              type: array
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Access List Entry for One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys createOrgAccessEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgApiKeyAccessListEntryApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tCreateOrgApiKeyAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \
            -d '{ <Payload> }'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createOrgApiKeyAccessListEntry
      x-xgen-method-verb-override:
        customMethod: false
        verb: createEntry
      x-xgen-operation-id-override: createOrgAccessEntry
  "/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 Service Account
        or 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: deleteOrgApiKeyAccessListEntry
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          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})?$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Access List Entry for One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys deleteAccessEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgApiKeyAccessListEntryApiParams{}\n\thttpResp,
          err := client.ProgrammaticAPIKeysApi.\n\t\tDeleteOrgApiKeyAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteOrgApiKeyAccessListEntry
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: deleteEntry
      x-xgen-operation-id-override: deleteAccessEntry
    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 Service Account or 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: getOrgApiKeyAccessListEntry
      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:
          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})?$"
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/UserAccessListResponse"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Access List Entry for One Organization API Key
      tags:
      - Programmatic API Keys
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api programmaticApiKeys getOrgAccessEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgApiKeyAccessListEntryApiParams{}\n\tsdkResp,
          httpResp, err := client.ProgrammaticAPIKeysApi.\n\t\tGetOrgApiKeyAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getOrgApiKeyAccessListEntry
      x-xgen-method-verb-override:
        customMethod: false
        verb: getEntry
      x-xgen-operation-id-override: getOrgAccessEntry
  "/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: createOrgBillingCostExplorerUsageProcess
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Cost Explorer Query Process
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices createCostExplorerProcess --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgBillingCostExplorerUsageProcessApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tCreateOrgBillingCostExplorerUsageProcessWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createOrgBillingCostExplorerUsageProcess
      x-xgen-method-verb-override:
        customMethod: false
        verb: createProcess
      x-xgen-operation-id-override: createCostExplorerProcess
  "/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 will indicate that another request should be sent
        later to view the data.
      operationId: getOrgBillingCostExplorerUsage
      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:
          example: 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C
          maxLength: 64
          minLength: 64
          type: string
      responses:
        '102':
          description: Processing
        '200':
          content:
            application/vnd.atlas.2023-01-01+csv:
              example: |
                Billed Date,666acb8787ba90706905dcae,
                Invoice Id,"June 1, 2024 - July 1, 2024",
                Organization Name,Test 2,
                Organization ID,666acb8787ba90706905dcae,
                Project Name,666acb8787ba90706905dcae,
                Project Id,666acb8787ba90706905dcae,
                Cluster Name,TestCluster
                Cluster Unique Id,666acb8787ba90706905dcae
                Usage Amount, 1018.39
              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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Usage Details for One Cost Explorer Query
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices getCostExplorerUsage --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgBillingCostExplorerUsageApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tGetOrgBillingCostExplorerUsageWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgBillingCostExplorerUsage
      x-xgen-operation-id-override: getCostExplorerUsage
  "/api/atlas/v2/orgs/{orgId}/events":
    get:
      description: |-
        Returns events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

        This resource remains under revision and may change.
      operationId: listOrgEvents
      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:
          items:
            "$ref": "#/components/schemas/EventTypeForOrg"
          type: array
      - 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:
          default: false
          type: boolean
      - description: Date and time from when MongoDB Cloud stops returning events.
          This parameter uses the ISO 8601 timestamp format in UTC.
        in: query
        name: maxDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      - description: Date and time from when MongoDB Cloud starts returning events.
          This parameter uses the ISO 8601 timestamp format in UTC.
        in: query
        name: minDate
        schema:
          externalDocs:
            description: ISO 8601
            url: https://en.wikipedia.org/wiki/ISO_8601
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/OrgPaginatedEventView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Events from One Organization
      tags:
      - Events
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api events listOrgEvents --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgEventsApiParams{}\n\tsdkResp,
          httpResp, err := client.EventsApi.\n\t\tListOrgEventsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrgEvents
  "/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 Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access.

        This resource remains under revision and may change.
      externalDocs:
        description: Return Events from One Organization
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents
      operationId: getOrgEvent
      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.
        in: path
        name: eventId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/EventViewForOrg"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Event from One Organization
      tags:
      - Events
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api events getOrgEvent --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgEventApiParams{}\n\tsdkResp,
          httpResp, err := client.EventsApi.\n\t\tGetOrgEventWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrgEvent
  "/api/atlas/v2/orgs/{orgId}/federationSettings":
    get:
      description: Returns information about the federation settings for the specified
        organization. To use this resource, the requesting Service Account or API
        Key must have the Organization Owner role in the connected organization.
      operationId: getOrgFederationSettings
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Federation Settings for One Organization
      tags:
      - Federated Authentication
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api federatedAuthentication getFederationSettings --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgFederationSettingsApiParams{}\n\tsdkResp,
          httpResp, err := client.FederatedAuthenticationApi.\n\t\tGetOrgFederationSettingsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getOrgFederationSettings
      x-xgen-operation-id-override: getFederationSettings
  "/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 Service Account or API Key must have the Organization Member role.
      operationId: getOrgGroups
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Projects in One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations getOrgGroups --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgGroupsApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tGetOrgGroupsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgGroups
  "/api/atlas/v2/orgs/{orgId}/invites":
    get:
      deprecated: true
      description: |-
        Returns all pending invitations to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by `orgMembershipStatus` to return all pending users.
      externalDocs:
        description: Return All MongoDB Cloud Users in One Organization
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers
      operationId: listOrgInvites
      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:
          format: email
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/OrganizationInvitation"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Invitations in One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations listOrgInvites --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgInvitesApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tListOrgInvitesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrgInvites
    patch:
      deprecated: true
      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 Service Account or API Key must have the Organization Owner role.

        **Note**:  Invitation management are deprecated. Use Update One MongoDB Cloud User in One Organization to update a pending user.
      externalDocs:
        description: Update One MongoDB Cloud User in One Organization
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser
      operationId: updateOrgInvites
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Invitation in One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations updateOrgInvites --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgInvitesApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tUpdateOrgInvitesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgInvites
    post:
      deprecated: true
      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 Service Account or API Key must have the Organization Owner role.

        **Note**: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user.
      externalDocs:
        description: Add One MongoDB Cloud User to One
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser
      operationId: createOrgInvite
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create Invitation for One MongoDB Cloud User in One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations createOrgInvite --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgInviteApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tCreateOrgInviteWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrgInvite
  "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}":
    delete:
      deprecated: true
      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 Service Account or API Key must have the Organization Owner role.

        **Note**: Invitation management APIs are deprecated. Use Remove One MongoDB Cloud User From One Organization to remove a pending user.
      externalDocs:
        description: Remove One MongoDB Cloud User in One Organization
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser
      operationId: deleteOrgInvite
      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:
              x-xgen-version: '2023-01-01'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Invitation from One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations deleteOrgInvite --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgInviteApiParams{}\n\thttpResp,
          err := client.OrganizationsApi.\n\t\tDeleteOrgInviteWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}"
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrgInvite
    get:
      deprecated: true
      description: |-
        Returns the details of one pending invitation to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user.
      externalDocs:
        description: Return One MongoDB Cloud User in One Organization
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser
      operationId: getOrgInvite
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/OrganizationInvitation"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Invitation in One Organization by Invitation ID
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations getOrgInvite --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgInviteApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tGetOrgInviteWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgInvite
    patch:
      deprecated: true
      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 Service Account or API Key must have the Organization Owner role.

        **Note**: Invitation management APIs are deprecated. Use Update One MongoDB Cloud User in One Organization to update a pending user.
      externalDocs:
        description: Update One MongoDB Cloud User in One Organization
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser
      operationId: updateOrgInviteById
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Invitation in One Organization by Invitation ID
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations updateOrgInviteById --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgInviteByIdApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tUpdateOrgInviteByIdWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgInviteById
      x-xgen-method-verb-override:
        customMethod: false
        verb: updateById
  "/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 Service Account or 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.
        To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula `totalBilledCents` * `unitPrice` + `salesTax` - `startingBalanceCents`.
      operationId: listOrgInvoices
      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: Flag that indicates whether to return linked invoices in the
          `linkedInvoices` field.
        in: query
        name: viewLinkedInvoices
        schema:
          default: true
          type: boolean
      - description: Statuses of the invoice to be retrieved. Omit to return invoices
          of all statuses.
        in: query
        name: statusNames
        schema:
          items:
            enum:
            - PENDING
            - CLOSED
            - FORGIVEN
            - FAILED
            - PAID
            - FREE
            - PREPAID
            - INVOICED
            type: string
          type: array
          uniqueItems: true
      - description: Retrieve the invoices the `startDates` of which are greater than
          or equal to the `fromDate`. If omit, the invoices return will go back to
          earliest `startDate`.
        in: query
        name: fromDate
        schema:
          example: '2023-01-01'
          format: date
          type: string
      - description: Retrieve the invoices the `endDates` of which are smaller than
          or equal to the `toDate`. If omit, the invoices return will go further to
          latest `endDate`.
        in: query
        name: toDate
        schema:
          example: '2023-01-01'
          format: date
          type: string
      - description: Field used to sort the returned invoices by. Use in combination
          with `orderBy` parameter to control the order of the result.
        in: query
        name: sortBy
        schema:
          default: END_DATE
          enum:
          - START_DATE
          - END_DATE
          type: string
      - description: Field used to order the returned invoices by. Use in combination
          of `sortBy` parameter to control the order of the result.
        example: desc
        in: query
        name: orderBy
        schema:
          default: desc
          enum:
          - desc
          - asc
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiInvoiceMetadataView"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Invoices for One Organization
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices listInvoices --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgInvoicesApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tListOrgInvoicesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listOrgInvoices
      x-xgen-operation-id-override: listInvoices
  "/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 Service
        Account or 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: listOrgInvoicePending
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Pending Invoices for One Organization
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices listInvoicePending --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgInvoicePendingApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tListOrgInvoicePendingWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listOrgInvoicePending
      x-xgen-operation-id-override: listInvoicePending
  "/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 Service Account or 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.
        To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula `totalBilledCents` * `unitPrice` + `salesTax` - `startingBalanceCents`.
      operationId: getOrgInvoice
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+csv:
              example: |
                Invoice Number,666acb8787ba43606905dcae,
                Billing Period,"June 1, 2024 - July 1, 2024",
                Organization Name,Test 2,
                Organization ID,666acb8787ba43606905dcac,

                Date,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount
              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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Invoice for One Organization
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices getInvoice --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgInvoiceApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tGetOrgInvoiceWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgInvoice
      x-xgen-operation-id-override: getInvoice
  "/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 Service Account or 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.
         To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula `totalBilledCents` * `unitPrice` + `salesTax` - `startingBalanceCents`.
      operationId: getOrgInvoiceCsv
      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:
          pattern: "[0-9a-f]+"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+csv:
              example: |
                Invoice Number,666acb8787ba43606905dcae,
                Billing Period,"June 1, 2024 - July 1, 2024",
                Organization Name,Test 2,
                Organization ID,666acb8787ba43606905dcac,

                Date,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount
              schema:
                type: string
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Invoice as CSV for One Organization
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices getInvoiceCsv --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgInvoiceCsvApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tGetOrgInvoiceCsvWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+csv" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+csv" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getOrgInvoiceCsv
      x-xgen-operation-id-override: getInvoiceCsv
  "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search":
    get:
      description: Query the `lineItems` of the specified invoice and return the result
        JSON. A unique 24-hexadecimal digit string identifies the invoice.
      operationId: searchOrgInvoiceLineItems
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/orgId"
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ApiPublicUsageDetailsQueryRequest"
        description: Filter parameters for the `lineItems` query. Send a request with
          an empty JSON body to retrieve all line items for a given `invoiceID` without
          applying any filters.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Line Items for One Invoice by Invoice ID
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices searchInvoiceLineItems --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.SearchOrgInvoiceLineItemsApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tSearchOrgInvoiceLineItemsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/searchOrgInvoiceLineItems
      x-xgen-operation-id-override: searchInvoiceLineItems
  "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects":
    get:
      description: Return all projects that you can migrate to the specified organization.
      operationId: listOrgLiveMigrationAvailableProjects
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                items:
                  "$ref": "#/components/schemas/LiveImportAvailableProject"
                type: array
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Projects Available for Migration
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService listAvailableProjects --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgLiveMigrationAvailableProjectsApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tListOrgLiveMigrationAvailableProjectsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listOrgLiveMigrationAvailableProjects
      x-xgen-operation-id-override: listAvailableProjects
  "/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: deleteOrgLiveMigrationLinkTokens
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/envelope"
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Link-Token
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService deleteLinkTokens --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgLiveMigrationLinkTokensApiParams{}\n\thttpResp,
          err := client.CloudMigrationServiceApi.\n\t\tDeleteOrgLiveMigrationLinkTokensWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteOrgLiveMigrationLinkTokens
      x-xgen-operation-id-override: deleteLinkTokens
    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: createOrgLiveMigrationLinkToken
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Link-Token
      tags:
      - Cloud Migration Service
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api cloudMigrationService createLinkToken --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgLiveMigrationLinkTokenApiParams{}\n\tsdkResp,
          httpResp, err := client.CloudMigrationServiceApi.\n\t\tCreateOrgLiveMigrationLinkTokenWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createOrgLiveMigrationLinkToken
      x-xgen-operation-id-override: createLinkToken
  "/api/atlas/v2/orgs/{orgId}/nonCompliantResources":
    get:
      description: Return all non-compliant resources for an organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: getOrgNonCompliantResources
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                items:
                  "$ref": "#/components/schemas/ApiAtlasNonCompliantResourceView"
                type: array
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Non-Compliant Resources
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies getNonCompliantResources --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgNonCompliantResourcesApiParams{}\n\tsdkResp,
          httpResp, err := client.ResourcePoliciesApi.\n\t\tGetOrgNonCompliantResourcesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/nonCompliantResources?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/nonCompliantResources?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getOrgNonCompliantResources
      x-xgen-operation-id-override: getNonCompliantResources
  "/api/atlas/v2/orgs/{orgId}/resourcePolicies":
    get:
      description: Return all Atlas Resource Policies for the organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: listOrgResourcePolicies
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                items:
                  "$ref": "#/components/schemas/ApiAtlasResourcePolicyView"
                type: array
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Atlas Resource Policies
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies listOrgResourcePolicies --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgResourcePoliciesApiParams{}\n\tsdkResp,
          httpResp, err := client.ResourcePoliciesApi.\n\t\tListOrgResourcePoliciesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/listOrgResourcePolicies
    post:
      description: Create one Atlas Resource Policy for an organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: createOrgResourcePolicy
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ApiAtlasResourcePolicyCreateView"
            x-xgen-version: '2024-08-05'
        description: Atlas Resource Policy to create.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasResourcePolicyView"
              x-xgen-version: '2024-08-05'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView"
              x-xgen-version: '2024-08-05'
          description: Bad request.
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Atlas Resource Policy
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies createOrgResourcePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgResourcePolicyApiParams{}\n\tsdkResp,
          httpResp, err := client.ResourcePoliciesApi.\n\t\tCreateOrgResourcePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createOrgResourcePolicy
  "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}":
    delete:
      description: Delete one Atlas Resource Policy for an organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: deleteOrgResourcePolicy
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      - description: Unique 24-hexadecimal digit string that identifies an atlas resource
          policy.
        in: path
        name: resourcePolicyId
        required: true
        schema:
          description: Unique 24-hexadecimal character string that identifies the
            atlas resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Atlas Resource Policy
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies deleteOrgResourcePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgResourcePolicyApiParams{}\n\thttpResp,
          err := client.ResourcePoliciesApi.\n\t\tDeleteOrgResourcePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteOrgResourcePolicy
    get:
      description: Return one Atlas Resource Policy for an organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: getOrgResourcePolicy
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      - description: Unique 24-hexadecimal digit string that identifies an atlas resource
          policy.
        in: path
        name: resourcePolicyId
        required: true
        schema:
          description: Unique 24-hexadecimal character string that identifies the
            atlas resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasResourcePolicyView"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Atlas Resource Policy
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies getOrgResourcePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgResourcePolicyApiParams{}\n\tsdkResp,
          httpResp, err := client.ResourcePoliciesApi.\n\t\tGetOrgResourcePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getOrgResourcePolicy
    patch:
      description: Update one Atlas Resource Policy for an organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: updateOrgResourcePolicy
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      - description: Unique 24-hexadecimal digit string that identifies an atlas resource
          policy.
        in: path
        name: resourcePolicyId
        required: true
        schema:
          description: Unique 24-hexadecimal character string that identifies the
            atlas resource policy.
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          readOnly: true
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ApiAtlasResourcePolicyEditView"
            x-xgen-version: '2024-08-05'
        description: Atlas Resource Policy to update.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasResourcePolicyView"
              x-xgen-version: '2024-08-05'
          description: Ok
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView"
              x-xgen-version: '2024-08-05'
          description: Bad request.
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Atlas Resource Policy
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies updateOrgResourcePolicy --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgResourcePolicyApiParams{}\n\tsdkResp,
          httpResp, err := client.ResourcePoliciesApi.\n\t\tUpdateOrgResourcePolicyWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateOrgResourcePolicy
  "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate":
    post:
      description: Validate one Atlas Resource Policy for an organization.
      externalDocs:
        description: Atlas Resource Policies
        url: https://dochub.mongodb.org/core/atlas-resource-policies
      operationId: validateOrgResourcePolicies
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/orgId"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ApiAtlasResourcePolicyCreateView"
            x-xgen-version: '2024-08-05'
        description: Atlas Resource Policy to create.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasResourcePolicyView"
              x-xgen-version: '2024-08-05'
          description: Ok
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView"
              x-xgen-version: '2024-08-05'
          description: Bad request.
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Validate One Atlas Resource Policy
      tags:
      - Resource Policies
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api resourcePolicies validateResourcePolicies --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ValidateOrgResourcePoliciesApiParams{}\n\tsdkResp,
          httpResp, err := client.ResourcePoliciesApi.\n\t\tValidateOrgResourcePoliciesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateOrgResourcePolicies
      x-xgen-operation-id-override: validateResourcePolicies
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts":
    get:
      description: Returns all Service Accounts for the specified Organization.
      operationId: listOrgServiceAccounts
      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.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedOrgServiceAccounts"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Organization Service Accounts
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts listOrgServiceAccounts --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgServiceAccountsApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tListOrgServiceAccountsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true"
      x-rolesRequirements:
      - Organization Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listOrgServiceAccounts
    post:
      description: Creates one Service Account for the specified Organization.
      operationId: createOrgServiceAccount
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/OrgServiceAccountRequest"
        description: Details of the new Service Account.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/OrgServiceAccount"
              x-xgen-version: '2024-08-05'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts createOrgServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tCreateOrgServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccount
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}":
    delete:
      description: Deletes the specified Service Account.
      operationId: deleteOrgServiceAccount
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts deleteOrgServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgServiceAccountApiParams{}\n\thttpResp,
          err := client.ServiceAccountsApi.\n\t\tDeleteOrgServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccount
    get:
      description: Returns the specified Service Account.
      operationId: getOrgServiceAccount
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/OrgServiceAccount"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts getOrgServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tGetOrgServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true"
      x-rolesRequirements:
      - Organization Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getOrgServiceAccount
    patch:
      description: Updates the specified Service Account in the specified Organization.
      operationId: updateOrgServiceAccount
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/OrgServiceAccountUpdateRequest"
        description: The new details for the Service Account.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/OrgServiceAccount"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts updateOrgServiceAccount --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgServiceAccountApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tUpdateOrgServiceAccountWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateOrgServiceAccount
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList":
    get:
      description: Returns all access list entries that you configured for the specified
        Service Account for the organization.
      operationId: listOrgServiceAccountAccessList
      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: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedServiceAccountIPAccessEntryView"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Access List Entries for One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts listOrgAccessList --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgServiceAccountAccessListApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tListOrgServiceAccountAccessListWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList?pretty=true"
      x-rolesRequirements:
      - Organization Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listOrgServiceAccountAccessList
      x-xgen-operation-id-override: listOrgAccessList
    post:
      description: Add Access List Entries for the specified Service Account for the
        organization. Resources require all API requests to originate from IP addresses
        on the API access list.
      operationId: createOrgServiceAccountAccessList
      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: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              items:
                "$ref": "#/components/schemas/ServiceAccountIPAccessListEntry"
              maxItems: 200
              type: array
            x-xgen-version: '2024-08-05'
        description: A list of access list entries to add to the access list of the
          specified Service Account for the organization.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedServiceAccountIPAccessEntryView"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add Access List Entries for One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts createOrgAccessList --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgServiceAccountAccessListApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tCreateOrgServiceAccountAccessListWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccountAccessList
      x-xgen-operation-id-override: createOrgAccessList
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}":
    delete:
      description: Removes the specified access list entry from the specified Service
        Account for the organization. You can't remove the requesting IP address from
        the access list.
      operationId: deleteOrgServiceAccountAccessListEntry
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - description: One IP address or multiple IP addresses represented as one CIDR
          block. When specifying 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:
          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})?$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Access List Entry from One Organization Service Account
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts deleteOrgAccessEntry --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgServiceAccountAccessListEntryApiParams{}\n\thttpResp,
          err := client.ServiceAccountsApi.\n\t\tDeleteOrgServiceAccountAccessListEntryWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccountAccessListEntry
      x-xgen-method-verb-override:
        customMethod: true
        verb: deleteEntry
      x-xgen-operation-id-override: deleteOrgAccessEntry
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups":
    get:
      description: Returns a list of all projects the specified Service Account is
        a part of.
      operationId: getOrgServiceAccountGroups
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      responses:
        '200':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/PaginatedServiceAccountGroup"
              x-xgen-version: '2024-08-05'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Service Account Project Assignments
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts getServiceAccountGroups --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgServiceAccountGroupsApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tGetOrgServiceAccountGroupsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups?pretty=true"
      x-rolesRequirements:
      - Organization Read Only
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getOrgServiceAccountGroups
      x-xgen-operation-id-override: getServiceAccountGroups
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets":
    post:
      description: Create a secret for the specified Service Account.
      operationId: createOrgServiceAccountSecret
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2024-08-05+json:
            schema:
              "$ref": "#/components/schemas/ServiceAccountSecretRequest"
        description: Details for the new secret.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2024-08-05+json:
              schema:
                "$ref": "#/components/schemas/ServiceAccountSecret"
              x-xgen-version: '2024-08-05'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Organization Service Account Secret
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts createOrgSecret --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgServiceAccountSecretApiParams{}\n\tsdkResp,
          httpResp, err := client.ServiceAccountsApi.\n\t\tCreateOrgServiceAccountSecretWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createOrgServiceAccountSecret
      x-xgen-operation-id-override: createOrgSecret
  "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}":
    delete:
      description: Deletes the specified Service Account secret.
      operationId: deleteOrgServiceAccountSecret
      parameters:
      - description: The Client ID of the Service Account.
        in: path
        name: clientId
        required: true
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies 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.2024-08-05+json:
              x-xgen-version: '2024-08-05'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Delete One Organization Service Account Secret
      tags:
      - Service Accounts
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api serviceAccounts deleteOrgSecret --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgServiceAccountSecretApiParams{}\n\thttpResp,
          err := client.ServiceAccountsApi.\n\t\tDeleteOrgServiceAccountSecretWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteOrgServiceAccountSecret
      x-xgen-operation-id-override: deleteOrgSecret
  "/api/atlas/v2/orgs/{orgId}/settings":
    get:
      description: Returns details about the specified organization's settings. To
        use this resource, the requesting Service Account or API Key must have the
        Organization Member role.
      operationId: getOrgSettings
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return Settings for One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations getOrgSettings --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgSettingsApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tGetOrgSettingsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrgSettings
    patch:
      description: Updates the organization's settings. To use this resource, the
        requesting Service Account or API Key must have the Organization Owner role.
      operationId: updateOrgSettings
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Settings for One Organization
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations updateOrgSettings --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgSettingsApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tUpdateOrgSettingsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgSettings
  "/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
        Service Account or 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: listOrgTeams
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Teams in One Organization
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams listOrgTeams --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgTeamsApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tListOrgTeamsWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrgTeams
    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 Service Account or 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: createOrgTeam
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One Team in One Organization
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams createOrgTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgTeamApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tCreateOrgTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createOrgTeam
  "/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 Service
        Account or 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: getOrgTeamByName
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Team by Name
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams getTeamByName --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgTeamByNameApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tGetOrgTeamByNameWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getOrgTeamByName
      x-xgen-operation-id-override: getTeamByName
  "/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 Service Account or
        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: deleteOrgTeam
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Team from One Organization
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams deleteOrgTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteOrgTeamApiParams{}\n\thttpResp,
          err := client.TeamsApi.\n\t\tDeleteOrgTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteOrgTeam
    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
        Service Account or 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: getOrgTeam
      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:
          pattern: "^([a-f0-9]{24})$"
          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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Team by ID
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams getOrgTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgTeamApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tGetOrgTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getOrgTeam
    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 Service Account or 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: renameOrgTeam
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Rename One Team
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams renameOrgTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RenameOrgTeamApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tRenameOrgTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameOrgTeam
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: rename
  "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users":
    get:
      description: |-
        Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

        **Note**: This resource cannot be used to view details about users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.

        **Note**: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: listOrgTeamUsers
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: Email address to filter users by. Not supported in deprecated
          versions.
        in: query
        name: username
        schema:
          format: email
          type: string
      - description: Organization membership status to filter users by. If you exclude
          this parameter, this resource returns both pending and active users. Not
          supported in deprecated versions.
        in: query
        name: orgMembershipStatus
        schema:
          example: ACTIVE
          type: string
      - description: Unique 24-hexadecimal digit string to filter users by. Not supported
          in deprecated versions.
        in: query
        name: userId
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/PaginatedOrgUserView"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All MongoDB Cloud Users Assigned to One Team
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers listTeamUsers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgTeamUsersApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tListOrgTeamUsersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrgTeamUsers
      x-xgen-operation-id-override: listTeamUsers
    post:
      deprecated: true
      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 Service Account or API Key must have the Organization Owner role.

        **Note**: This endpoint is deprecated. Use [Add One MongoDB Cloud User to One Team](#tag/MongoDB-Cloud-Users/operation/addUserToTeam) to add an active or pending user to a team.
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: addOrgTeamUsers
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2023-01-01+json:
            schema:
              items:
                "$ref": "#/components/schemas/AddUserToTeam"
              type: array
        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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Assign MongoDB Cloud Users in One Organization to One Team
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams addTeamUsers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddOrgTeamUsersApiParams{}\n\tsdkResp,
          httpResp, err := client.TeamsApi.\n\t\tAddOrgTeamUsersWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addOrgTeamUsers
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: add
      x-xgen-operation-id-override: addTeamUsers
  "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}":
    delete:
      deprecated: true
      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 Service Account or API Key must have the Organization Owner role.

        **Note**: This endpoint is deprecated. Use [Remove One MongoDB Cloud User from One Team](#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam) to remove an active or pending user from a team.
      externalDocs:
        description: Manage Organization Teams
        url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams
      operationId: removeOrgTeamUserFromTeam
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - 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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      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.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One MongoDB Cloud User from One Team
      tags:
      - Teams
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api teams removeUserFromTeam --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveOrgTeamUserFromTeamApiParams{}\n\thttpResp,
          err := client.TeamsApi.\n\t\tRemoveOrgTeamUserFromTeamWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}"
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeOrgTeamUserFromTeam
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: removeFromTeam
      x-xgen-operation-id-override: removeUserFromTeam
  "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser":
    post:
      description: |-
        Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project
          endpoint'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation
      operationId: addOrgTeamUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the team to
          add the MongoDB Cloud user to.
        in: path
        name: teamId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/AddOrRemoveUserFromTeam"
        description: The active or pending MongoDB Cloud user that you want to add
          to the specified team.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One MongoDB Cloud User to One Team
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers addOrgTeamUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddOrgTeamUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tAddOrgTeamUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrgTeamUser
  "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser":
    post:
      description: |-
        Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: removeOrgTeamUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the team to
          remove the MongoDB user from.
        in: path
        name: teamId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/AddOrRemoveUserFromTeam"
        description: The id of the active or pending MongoDB Cloud user that you want
          to remove from the specified team.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One MongoDB Cloud User from One Team
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers removeOrgTeamUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveOrgTeamUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tRemoveOrgTeamUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgTeamUser
  "/api/atlas/v2/orgs/{orgId}/users":
    get:
      description: |-
        Returns details about the pending and active MongoDB Cloud users associated with the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

        **Note**: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

        **Note**: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: listOrgUsers
      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"
      - description: Email address to filter users by. Not supported in deprecated
          versions.
        in: query
        name: username
        schema:
          format: email
          type: string
      - description: Organization membership status to filter users by. If you exclude
          this parameter, this resource returns both pending and active users. Not
          supported in deprecated versions.
        in: query
        name: orgMembershipStatus
        schema:
          example: ACTIVE
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/PaginatedOrgUserView"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All MongoDB Cloud Users in One Organization
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers listOrgUsers --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgUsersApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tListOrgUsersWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrgUsers
    post:
      description: |-
        Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.
      operationId: createOrgUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/OrgUserRequest"
        description: Represents the MongoDB Cloud user to be created within the organization.
        required: true
      responses:
        '201':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: Created
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One MongoDB Cloud User to One Organization
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers createOrgUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateOrgUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tCreateOrgUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrgUser
  "/api/atlas/v2/orgs/{orgId}/users/{userId}":
    delete:
      description: |-
        Removes one MongoDB Cloud user in the specified organization. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

        **Note**: To remove pending or active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users can be removed. Deprecated versions: v2-{2023-01-01}
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: removeOrgUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the organization. If you need to lookup a user's `userId`
          or verify a user's status in the organization, use the [Return All MongoDB
          Cloud Users in One Organization](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers)
          resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '204':
          content:
            application/vnd.atlas.2025-02-19+json:
              x-xgen-version: '2025-02-19'
          description: This endpoint does not return a response body.
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One MongoDB Cloud User from One Organization
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers removeOrgUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveOrgUserApiParams{}\n\thttpResp,
          err := client.MongoDBCloudUsersApi.\n\t\tRemoveOrgUserWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}"
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgUser
      x-xgen-method-verb-override:
        customMethod: 'True'
        verb: remove
    get:
      description: |-
        Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

        **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.

        **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.
      operationId: getOrgUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the organization. If you need to lookup a user's `userId`
          or verify a user's status in the organization, use the Return All MongoDB
          Cloud Users in One Organization resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One MongoDB Cloud User in One Organization
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers getOrgUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tGetOrgUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}?pretty=true"
      x-rolesRequirements:
      - Organization Member
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrgUser
    patch:
      description: |-
        Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.

        **Note**: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: updateOrgUser
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the organization. If you need to lookup a user's `userId`
          or verify a user's status in the organization, use the Return All MongoDB
          Cloud Users in One Organization resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/OrgUserUpdateRequest"
        description: Represents the roles and teams to assign the MongoDB Cloud user.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update One MongoDB Cloud User in One Organization
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers updateOrgUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tUpdateOrgUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrgUser
  "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles":
    put:
      deprecated: true
      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 Service Account or API Key must have the Organization User
        Admin role.
      operationId: updateOrgUserRoles
      parameters:
      - "$ref": "#/components/parameters/orgId"
      - description: Unique 24-hexadecimal digit string that identifies the user to
          modify.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      - "$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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Update Organization Roles for One MongoDB Cloud User
      tags:
      - Organizations
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api organizations updateOrgUserRoles --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateOrgUserRolesApiParams{}\n\tsdkResp,
          httpResp, err := client.OrganizationsApi.\n\t\tUpdateOrgUserRolesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrgUserRoles
  "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole":
    post:
      description: |-
        Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: This operation is atomic.

        **Note**: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: 'Deprecated: Invite One MongoDB Cloud User to Join One Project'
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: addOrgUserRole
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the organization. If you need to lookup a user's `userId`
          or verify a user's status in the organization, use the Return All MongoDB
          Cloud Users in One Organization resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/AddOrRemoveOrgRole"
        description: Organization-level role to assign to the MongoDB Cloud user.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '409':
          "$ref": "#/components/responses/conflict"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Add One Organization Role to One MongoDB Cloud User
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers addOrgRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.AddOrgUserRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tAddOrgUserRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrgUserRole
      x-xgen-operation-id-override: addOrgRole
  "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole":
    post:
      description: |-
        Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

        **Note**: This operation is atomic.

        **Note**: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
      externalDocs:
        description: Invite One MongoDB Cloud User to Join One Project
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation
      operationId: removeOrgUserRole
      parameters:
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/orgId"
      - "$ref": "#/components/parameters/pretty"
      - description: Unique 24-hexadecimal digit string that identifies the pending
          or active user in the organization. If you need to lookup a user's `userId`
          or verify a user's status in the organization, use the Return All MongoDB
          Cloud Users in One Organization resource and filter by `username`.
        in: path
        name: userId
        required: true
        schema:
          pattern: "^([a-f0-9]{24})$"
          type: string
      requestBody:
        content:
          application/vnd.atlas.2025-02-19+json:
            schema:
              "$ref": "#/components/schemas/AddOrRemoveOrgRole"
        description: Organization-level role to remove from the MongoDB Cloud user.
        required: true
      responses:
        '200':
          content:
            application/vnd.atlas.2025-02-19+json:
              schema:
                "$ref": "#/components/schemas/OrgUserResponse"
              x-xgen-version: '2025-02-19'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Remove One Organization Role from One MongoDB Cloud User
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers removeOrgRole --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.RemoveOrgUserRoleApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tRemoveOrgUserRoleWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" \
            -d '{ <Payload> }'
      x-rolesRequirements:
      - Organization Owner
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrgUserRole
      x-xgen-operation-id-override: removeOrgRole
  "/api/atlas/v2/rateLimits":
    get:
      description: Get all rate limits for all v2 Atlas Administration API endpoint
        sets.
      operationId: listRateLimits
      parameters:
      - "$ref": "#/components/parameters/itemsPerPage"
      - "$ref": "#/components/parameters/pageNum"
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      - description: Unique 24-hexadecimal digit string that identifies the Atlas
          Project to request rate limits for. When this parameter is provided, only
          group scoped endpoint sets are returned and the limits returned are applicable
          to the specified project. The requesting user must have the Project Read
          Only role for the specified project.
        in: query
        name: groupId
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the Atlas
          Organization to request rate limits for. When this parameter is provided,
          only organization scoped endpoint sets are returned and the limits returned
          are applicable to the specified organization. The requesting user must have
          the Organization Read Only role for the specified organization.
        in: query
        name: orgId
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: A string that identifies the Atlas user to request rate limits
          for. The ID can for example be the Service Account Client ID or the API
          Public Key. When this parameter is provided, only user scoped endpoint sets
          are returned and the limits returned are applicable to the specified user.
          The requesting user must be the same as the specified user.
        in: query
        name: userId
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          type: string
      - description: An IP address to request rate limits for. When this parameter
          is provided, only IP scoped endpoint sets are returned and the limits returned
          are applicable to the specified IP address. The requesting user must have
          the same IP address as the one provided in the request.
        in: query
        name: ipAddress
        schema:
          example: 127.0.0.1
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
      - description: Filters the returned endpoint sets by the provided endpoint set
          name. Multiple names may be provided, for example `/rateLimits?name=Name1&name=Name2`.
          For names that use spaces, replace the space with its URL-encoded value
          (`%20`).
        in: query
        name: name
        schema:
          example: Rate Limits Inspection
          type: string
      - description: Filters the returned endpoint sets by the provided endpoint path.
          Multiple paths may be provided, for example `/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F`.
          Replace `/`, `{` and `}` with their URL-encoded values (`%2F`, `%7B` and
          `%7D` respectively).
        in: query
        name: endpointPath
        schema:
          example: "/api/atlas/v2/clusters"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/PaginatedRateLimitEndpointSets"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Rate Limits
      tags:
      - Rate Limiting
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api rateLimiting listRateLimits --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListRateLimitsApiParams{}\n\tsdkResp,
          httpResp, err := client.RateLimitingApi.\n\t\tListRateLimitsWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/rateLimits?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/rateLimits?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rate-Limiting/operation/listRateLimits
  "/api/atlas/v2/rateLimits/{endpointSetId}":
    get:
      description: Get one rate limit endpoint set.
      operationId: getRateLimit
      parameters:
      - description: The ID of the rate limit endpoint set.
        in: path
        name: endpointSetId
        required: true
        schema:
          example: rateLimitsInspection_group
          type: string
      - "$ref": "#/components/parameters/pretty"
      - "$ref": "#/components/parameters/envelope"
      - description: Unique 24-hexadecimal digit string that identifies the Atlas
          Project to request rate limits for. When this parameter is provided, the
          limits returned are applicable to the specified project. The requesting
          user must have the Project Read Only role for the specified project.
        in: query
        name: groupId
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: Unique 24-hexadecimal digit string that identifies the Atlas
          Organization to request rate limits for. When this parameter is provided,
          the limits returned are applicable to the specified organization. The requesting
          user must have the Organization Read Only role for the specified organization.
        in: query
        name: orgId
        schema:
          example: 32b6e34b3d91647abb20e7b8
          pattern: "^([a-f0-9]{24})$"
          type: string
      - description: A string that identifies the Atlas user to request rate limits
          for. The ID can for example be the Service Account Client ID or the API
          Public Key. When this parameter is provided, the limits returned are applicable
          to the specified  user. The requesting user must be the same as the specified
          user.
        in: query
        name: userId
        schema:
          example: mdb_sa_id_1234567890abcdef12345678
          type: string
      - description: An IP address to request rate limits for. When this parameter
          is provided, the limits returned are applicable to the specified IP address.
          The requesting user must have the same IP address as the one provided in
          the request.
        in: query
        name: ipAddress
        schema:
          example: 127.0.0.1
          pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/RateLimitEndpointSetResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '400':
          "$ref": "#/components/responses/badRequest"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Rate Limit
      tags:
      - Rate Limiting
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api rateLimiting getRateLimit --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetRateLimitApiParams{}\n\tsdkResp,
          httpResp, err := client.RateLimitingApi.\n\t\tGetRateLimitWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/rateLimits/{endpointSetId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/rateLimits/{endpointSetId}?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rate-Limiting/operation/getRateLimit
  "/api/atlas/v2/skus":
    get:
      description: Returns all available SKUs (Stock Keeping Units) that can appear
        on MongoDB invoices. SKUs represent different products and services offered
        by MongoDB.
      operationId: listSkus
      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.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/PaginatedApiSKUView"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return All Stock Keeping Units
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices listSkus --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListSkusApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tListSkusWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/skus?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/skus?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listSkus
  "/api/atlas/v2/skus/{skuId}":
    get:
      description: Returns details about a single SKU (Stock Keeping Unit) by its
        identifier. SKUs represent different products and services offered by MongoDB.
      operationId: getSku
      parameters:
      - description: Unique identifier of the SKU to retrieve.
        example: ATLAS_AWS_INSTANCE_M10
        in: path
        name: skuId
        required: true
        schema:
          type: string
      - "$ref": "#/components/parameters/envelope"
      - "$ref": "#/components/parameters/pretty"
      responses:
        '200':
          content:
            application/vnd.atlas.2025-03-12+json:
              schema:
                "$ref": "#/components/schemas/SkuResponse"
              x-xgen-version: '2025-03-12'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One Stock Keeping Unit
      tags:
      - Invoices
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api invoices getSku --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetSkuApiParams{}\n\tsdkResp,
          httpResp, err := client.InvoicesApi.\n\t\tGetSkuWithParams(ctx, params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/skus/{skuId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/skus/{skuId}?pretty=true"
      x-rolesRequirements:
      - Organization Billing Viewer
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getSku
  "/api/atlas/v2/unauth/controlPlaneIPAddresses":
    get:
      description: Returns all control plane IP addresses.
      operationId: listControlPlaneIpAddresses
      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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      security: []
      summary: Return All Control Plane IP Addresses
      tags:
      - Root
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api root listControlPlaneAddresses --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListControlPlaneIpAddressesApiParams{}\n\tsdkResp,
          httpResp, err := client.RootApi.\n\t\tListControlPlaneIpAddressesWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/listControlPlaneIpAddresses
      x-xgen-operation-id-override: listControlPlaneAddresses
  "/api/atlas/v2/users":
    post:
      deprecated: true
      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 Service Account or 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
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Create One MongoDB Cloud User
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers createUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tCreateUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
            -d '{ <Payload> }'
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            --header "Content-Type: application/json" \
            -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
            -d '{ <Payload> }'
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser
  "/api/atlas/v2/users/byName/{userName}":
    get:
      deprecated: true
      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
        API Key endpoint. To use this resource, the requesting Service Account or
        API Key can have any role.
      externalDocs:
        description: Return One Organization API Key
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey
      operationId: getUserByName
      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:
          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])?$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/CloudAppUser"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One MongoDB Cloud User by Username
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers getUserByName --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetUserByNameApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tGetUserByNameWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true"
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByName
  "/api/atlas/v2/users/{userId}":
    get:
      deprecated: true
      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 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 Service Account
        or API Key can have any role.
      externalDocs:
        description: Return One Organization API Key
        url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey
      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:
          pattern: "^([a-f0-9]{24})$"
          type: string
      responses:
        '200':
          content:
            application/vnd.atlas.2023-01-01+json:
              schema:
                "$ref": "#/components/schemas/CloudAppUser"
              x-xgen-version: '2023-01-01'
          description: OK
          headers:
            RateLimit-Limit:
              "$ref": "#/components/headers/HeaderRateLimitLimit"
            RateLimit-Remaining:
              "$ref": "#/components/headers/HeaderRateLimitRemaining"
        '401':
          "$ref": "#/components/responses/unauthorized"
        '403':
          "$ref": "#/components/responses/forbidden"
        '404':
          "$ref": "#/components/responses/notFound"
        '429':
          "$ref": "#/components/responses/tooManyRequests"
        '500':
          "$ref": "#/components/responses/internalServerError"
      summary: Return One MongoDB Cloud User by ID
      tags:
      - MongoDB Cloud Users
      x-codeSamples:
      - lang: cURL
        label: Atlas CLI
        source: atlas api mongoDbCloudUsers getUser --help
      - lang: go
        label: Go
        source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc
          main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret
          := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient,
          err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err
          != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetUserApiParams{}\n\tsdkResp,
          httpResp, err := client.MongoDBCloudUsersApi.\n\t\tGetUserWithParams(ctx,
          params).\n\t\tExecute()\n}\n"
      - lang: cURL
        label: curl (Service Accounts)
        source: |-
          curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true"
      - lang: cURL
        label: curl (Digest)
        source: |-
          curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
            --digest --include \
            --header "Accept: application/vnd.atlas.2025-03-12+json" \
            -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true"
      x-sunset: '2027-07-01'
      x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser
security:
- ServiceAccounts: []
- DigestAuth: []
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 pre-filtered activity feed links for projects and organizations.
    The returned links can be shared and opened to view the activity feed with the
    specified filters applied.
  name: Activity Feed
- 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, edits, and removes Atlas Data Lake Pipelines and associated
    runs.
  externalDocs:
    description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation
      Guide.
    url: https://dochub.mongodb.org/core/data-lake-deprecation
  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, edits, and removes flex clusters.
  name: Flex Clusters
- description: Returns and adds restore jobs for flex database deployments.
  name: Flex Restore Jobs
- description: Returns and requests to download flex database deployment snapshots.
  name: Flex Snapshots
- 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 export mongod, mongos, and audit logs to an AWS
    S3 bucket. The new `/logIntegrations` API provides 1-minute log export on a best-effort
    basis. The existing `/pushBasedLogExport` API provides 5-minute log export and
    will be deprecated in the future. The log export integrations are managed at the
    project level.
  name: Push-Based Log Export
- description: Returns details about rate limit policies for the Atlas Administration
    API.
  externalDocs:
    description: Atlas API Rate Limits documentation
    url: http://dochub.mongodb.org/core/atlas-api-rate-limit
  name: Rate Limiting
- description: Configure and manage Atlas Resource Policies within your organization.
  name: Resource Policies
- description: Creates one index to a database deployment in a rolling manner. Rolling
    indexes build indexes on the applicable nodes sequentially and may reduce the
    performance impact of an index build if your deployment's average CPU utilization
    exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of
    if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does
    not meet this criteria, use the default index build. 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: Endpoints for managing Service Accounts and secrets. Service Accounts
    are used for programmatic access to the Atlas Admin API through the OAuth 2.0
    Client Credentials flow.
  externalDocs:
    description: Get Started with the Atlas Administration API
    url: https://www.mongodb.com/docs/atlas/configure-api-access/
  name: Service Accounts
- description: Returns, adds, edits, and removes Streams Workspaces. 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
x-externalLinks:
- label: Back to Atlas Docs
  url: https://www.mongodb.com/docs/atlas/
- label: API Changelog
  url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
x-topics:
- content: The MongoDB Atlas Administration API is rate limited. To learn more about
    rate limiting, see the [Atlas Documentation on Rate Limiting](http://dochub.mongodb.org/core/atlas-api-rate-limit)
  title: Rate Limiting