--- openapi: 3.0.1 info: title: MongoDB Atlas Administration API description: |- The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. The Atlas Administration API uses OAuth Service Accounts or HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal: ``` curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ --digest \ --header "Accept: application/json" \ -X GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ version: '1.0' externalDocs: description: Back to Atlas Docs url: https://www.mongodb.com/docs/atlas/ servers: - url: https://cloud.mongodb.com security: - ServiceAccounts: [] - DigestAuth: [] tags: - name: Access Tracking 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: Alert Configurations description: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. - name: Alerts 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: Atlas Search 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: Auditing description: Returns and edits database auditing settings for MongoDB Cloud projects. - name: AWS Clusters DNS 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: Cloud Backups description: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. - name: Cloud Migration Service 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 Provider Access description: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. - name: Cluster Outage Simulation description: Returns, starts, or ends a cluster outage simulation. - name: Clusters description: Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. - name: Custom Database Roles 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: Data Federation 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 Lake Pipelines 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: Database Users description: Returns, adds, edits, and removes database users. - name: Encryption at Rest using Customer Key Management 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: Events description: Returns events. This collection remains under revision and may change. - name: Federated Authentication description: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. - name: Global Clusters 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: Invoices description: Returns invoices. - name: LDAP Configuration 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: Legacy Backup description: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. - name: Maintenance Windows 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: MongoDB Cloud Users description: Returns, adds, and edits MongoDB Cloud users. - name: Monitoring and Logs description: Returns database deployment monitoring and logging data. - name: Multi-Cloud Clusters description: |- Returns, adds, edits, or removes multi-cloud clusters. Changes to cluster configurations can affect costs. The total number of nodes in clusters spanning across regions has a specific constraint on a per-project basis. MongoDB Cloud limits the total number of nodes in other regions in one project to a total of 40. This total excludes Google Cloud regions communicating with each other, shared-tier clusters, or serverless clusters. The total number of nodes between any two regions must meet this constraint. For example, if a project has nodes in clusters spread across three regions: 30 nodes in Region A, 10 nodes in Region B, and 5 nodes in Region C, you can add only 5 more nodes to Region C because if you exclude Region C, Region A + Region B = 40. If you exclude Region B, Region A + Region C = 35, <= 40. If you exclude Region A, Region B + Region C = 15, <= 40. Each combination of regions with the added 5 nodes still meets the per-project constraint. Region A + B = 40. Region A + C = 40. Region B + C = 20. You can't create a multi-region cluster in a project if it has one or more clusters spanning 40 or more nodes in other regions. Each project supports up to 25 database deployments. If your MongoDB Cloud project contains a custom role that uses actions introduced in a specific MongoDB version, you must delete that role before you create clusters with an earlier MongoDB version. MongoDB Cloud clusters created after July 2020 use TLS version 1.2 by default. When you create a cluster, MongoDB Cloud creates a network container in the project for the cloud provider to which you deploy the cluster if one doesn't already exist. - name: Network Peering 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: Online Archive description: Returns, adds, edits, or removes an online archive. - name: Organizations description: Returns, adds, and edits organizational units in MongoDB Cloud. - name: Performance Advisor 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: Private Endpoint Services description: Returns, adds, edits, and removes private endpoint services. - name: Programmatic API Keys 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: Project IP Access List 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: Projects description: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. - name: Rolling Index 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: Root description: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. - name: Serverless Instances description: Returns, adds, edits, and removes serverless instances. - name: Serverless Private Endpoints 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: Shared-Tier Restore Jobs description: Returns and adds restore jobs for shared-tier database deployments. - name: Shared-Tier Snapshots description: Returns and requests to download shared-tier database deployment snapshots. - name: Teams description: Returns, adds, edits, or removes teams. - name: Third-Party Integrations 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: X.509 Authentication 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/ paths: "/api/atlas/v1.0/groups/{groupId}/events": get: tags: - Events summary: Return Events from One Project 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: listProjectEvents parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterNames in: query description: Human-readable label that identifies the cluster. style: form schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: eventType in: query description: |- Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/EventTypeForNdsGroup" - name: excludedEventType in: query 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. schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/EventTypeForNdsGroup" - name: includeRaw in: query description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. schema: type: boolean default: false - name: maxDate in: query description: Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. schema: type: string format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 - name: minDate in: query description: Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. schema: type: string format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupPaginatedEventView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Events/operation/listProjectEvents "/api/atlas/v1.0/groups/{groupId}/events/{eventId}": get: tags: - Events summary: Return One Event from One Project 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: getProjectEvent parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: eventId in: path description: Unique 24-hexadecimal digit string that identifies the event that you want to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: includeRaw in: query description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/EventViewForNdsGroup" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Events/operation/getProjectEvent "/api/atlas/v1.0/orgs/{orgId}/events": get: tags: - Events summary: Return Events from One Organization 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: listOrganizationEvents parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: eventType in: query description: |- Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/EventTypeForOrg" - name: includeRaw in: query description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. schema: type: boolean default: false - name: maxDate in: query description: Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. schema: type: string format: date-time - name: minDate in: query description: Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. schema: type: string format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrgPaginatedEventView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Events/operation/listOrganizationEvents "/api/atlas/v1.0/orgs/{orgId}/events/{eventId}": get: tags: - Events summary: Return One Event from One Organization 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: getOrganizationEvent parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: eventId in: path description: Unique 24-hexadecimal digit string that identifies the event that you want to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: includeRaw in: query description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/EventViewForOrg" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Events/operation/getOrganizationEvent "/api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}/alerts": get: tags: - Alerts summary: Return All Open Alerts for One Alert Configuration 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: listAlertsByAlertConfigurationId parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: alertConfigId in: path description: Unique 24-hexadecimal digit string that identifies the alert configuration. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAlertView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alerts/operation/listAlertsByAlertConfigurationId "/api/atlas/v1.0/groups/{groupId}/alerts/{alertId}": get: tags: - Alerts summary: Return One Alert from One Project 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. This resource remains under revision and may change. operationId: getAlert parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: alertId in: path description: Unique 24-hexadecimal digit string that identifies the alert. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AlertViewForNdsGroup" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alerts/operation/getAlert patch: tags: - Alerts summary: Acknowledge One Alert from One Project 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 Organization Owner or Project Owner role. This resource remains under revision and may change. operationId: acknowledgeAlert parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: alertId in: path description: Unique 24-hexadecimal digit string that identifies the alert. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Acknowledges or unacknowledges one alert. content: application/json: schema: "$ref": "#/components/schemas/AlertView" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AlertViewForNdsGroup" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alerts/operation/acknowledgeAlert "/api/atlas/v1.0/groups/{groupId}/alerts": get: tags: - Alerts summary: Return All Alerts from One Project 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: listAlerts parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: status in: query 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. schema: type: string enum: - OPEN - TRACKING - CLOSED responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAlertView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alerts/operation/listAlerts "/api/atlas/v1.0/groups/{groupId}/alerts/{alertId}/alertConfigs": get: tags: - Alert Configurations summary: Return All Alert Configurations Set for One Alert 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: listAlertConfigurationsByAlertId parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - name: alertId in: path description: Unique 24-hexadecimal digit string that identifies the alert. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAlertConfigView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId "/api/atlas/v1.0/alertConfigs/matchers/fieldNames": get: tags: - Alert Configurations summary: Return All Alert Configuration Matchers Field Names description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. operationId: listAlertConfigurationMatchersFieldNames parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MatcherFieldView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames "/api/atlas/v1.0/groups/{groupId}/alertConfigs": get: tags: - Alert Configurations summary: Return All Alert Configurations in One Project 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: listAlertConfigurations parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAlertConfigView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/listAlertConfigurations post: tags: - Alert Configurations summary: Create One Alert Configuration in One Project 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 Organization Owner or Project Owner role. This resource remains under revision and may change. operationId: createAlertConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Creates one alert configuration for the specified project. content: application/json: schema: "$ref": "#/components/schemas/GroupAlertsConfig" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupAlertsConfig" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/createAlertConfiguration "/api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}": get: tags: - Alert Configurations summary: Return One Alert Configuration from One Project 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: getAlertConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: alertConfigId in: path description: Unique 24-hexadecimal digit string that identifies the alert configuration. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupAlertsConfig" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/getAlertConfiguration put: tags: - Alert Configurations summary: Update One Alert Configuration in One Project 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 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: updateAlertConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: alertConfigId in: path description: Unique 24-hexadecimal digit string that identifies the alert configuration. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 requestBody: description: Updates one alert configuration in the specified project. content: application/json: schema: "$ref": "#/components/schemas/GroupAlertsConfig" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupAlertsConfig" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/updateAlertConfiguration delete: tags: - Alert Configurations summary: Remove One Alert Configuration from One Project description: |- Removes one alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the 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: deleteAlertConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: alertConfigId in: path description: Unique 24-hexadecimal digit string that identifies the alert configuration. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '204': description: No Content '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/deleteAlertConfiguration patch: tags: - Alert Configurations summary: Toggle State of One Alert Configuration in One Project 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 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: toggleAlertConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: alertConfigId in: path description: Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 requestBody: description: Enables or disables the specified alert configuration in the specified project. content: application/json: schema: "$ref": "#/components/schemas/AlertsToggle" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupAlertsConfig" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Alert-Configurations/operation/toggleAlertConfiguration "/api/atlas/v1.0": get: tags: - Root summary: Return the status of this MongoDB application 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': description: OK content: application/json: schema: "$ref": "#/components/schemas/SystemStatus" '401': description: Unauthorized. content: application/json: schema: "$ref": "#/components/schemas/ApiError" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Root/operation/getSystemStatus "/api/atlas/v1.0/clusters": get: tags: - Clusters summary: Return All Authorized Clusters in All Projects 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: listClustersForAllProjects parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedOrgGroupView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/listClustersForAllProjects "/api/atlas/v1.0/orgs": get: tags: - Organizations summary: Return All Organizations 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: listOrganizations parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: name in: query 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. schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedOrganizationView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/listOrganizations post: tags: - Organizations summary: Create One Organization 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. externalDocs: description: Configure a Paying Organization url: https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization operationId: createOrganization parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" requestBody: description: Organization that you want to create. content: application/json: schema: "$ref": "#/components/schemas/CreateOrganizationRequest" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/CreateOrganizationResponse" '400': "$ref": "#/components/responses/badRequest" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/unauthorized" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/createOrganization "/api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users": get: tags: - Teams summary: Return All MongoDB Cloud Users Assigned to One Team description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting 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: listTeamUsers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAppUserView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/listTeamUsers post: tags: - Teams summary: Assign MongoDB Cloud Users in One Organization to One Team 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. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams operationId: addTeamUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: One or more MongoDB Cloud users that you want to add to the specified team. content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AddUserToTeam" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAppUserView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/addTeamUser "/api/atlas/v1.0/orgs/{orgId}/teams": get: tags: - Teams summary: Return All Teams in One Organization 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: listOrganizationTeams parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedTeamView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/listOrganizationTeams post: tags: - Teams summary: Create One Team in One Organization 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: createTeam parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" requestBody: description: Team that you want to create in the specified organization. content: application/json: schema: "$ref": "#/components/schemas/Team" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Team" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/createTeam "/api/atlas/v1.0/orgs/{orgId}/teams/{teamId}": get: tags: - Teams summary: Return One Team by ID 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: getTeamById parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team whose information you want to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TeamResponse" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/getTeamById delete: tags: - Teams summary: Remove One Team from One Organization 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: deleteTeam parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team that you want to delete. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/deleteTeam patch: tags: - Teams summary: Rename One Team 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: renameTeam parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team that you want to rename. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Details to update on the specified team. content: application/json: schema: "$ref": "#/components/schemas/TeamUpdate" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TeamResponse" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/renameTeam "/api/atlas/v1.0/orgs/{orgId}/teams/byName/{teamName}": get: tags: - Teams summary: Return One Team by Name 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: getTeamByName parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: teamName in: path description: Name of the team whose information you want to return. required: true schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TeamResponse" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/getTeamByName "/api/atlas/v1.0/orgs/{orgId}/teams/{teamId}/users/{userId}": delete: tags: - Teams summary: Remove One MongoDB Cloud User from One Team 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. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams operationId: removeTeamUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: userId in: path description: Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/removeTeamUser "/api/atlas/v1.0/orgs/{orgId}/users/{userId}": delete: tags: - Organizations summary: Remove One MongoDB Cloud User from One Organization description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. operationId: removeOrganizationUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: userId in: path description: Unique 24-hexadecimal digit string that identifies the user to be deleted. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/removeOrganizationUser "/api/atlas/v1.0/orgs/{orgId}": get: tags: - Organizations summary: Return One Organization 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: getOrganization parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AtlasOrganization" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/getOrganization delete: tags: - Organizations summary: Remove One Organization 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: deleteOrganization parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '402': "$ref": "#/components/responses/paymentRequired" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/deleteOrganization patch: tags: - Organizations summary: Update One Organization description: Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. operationId: updateOrganization parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" requestBody: description: Details to update on the specified organization. content: application/json: schema: "$ref": "#/components/schemas/AtlasOrganization" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AtlasOrganization" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/updateOrganization "/api/atlas/v1.0/orgs/{orgId}/federationSettings": get: tags: - Federated Authentication summary: Return Federation Settings for One Organization 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 org. operationId: getFederationSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrgFederationSettings" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/getFederationSettings "/api/atlas/v1.0/orgs/{orgId}/groups": get: tags: - Organizations summary: Return All Projects in One Organization 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: listOrganizationProjects parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: name in: query 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. schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAtlasGroupView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/listOrganizationProjects "/api/atlas/v1.0/orgs/{orgId}/settings": get: tags: - Organizations summary: Return Settings for One Organization 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: getOrganizationSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrganizationSettings" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/getOrganizationSettings patch: tags: - Organizations summary: Update Settings for One Organization description: Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. operationId: updateOrganizationSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" requestBody: description: Details to update on the specified organization's settings. content: application/json: schema: "$ref": "#/components/schemas/OrganizationSettings" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrganizationSettings" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/updateOrganizationSettings "/api/atlas/v1.0/orgs/{orgId}/users": get: tags: - Organizations summary: Return All MongoDB Cloud Users in One Organization description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. operationId: listOrganizationUsers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAppUserView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/listOrganizationUsers "/api/atlas/v1.0/users": post: tags: - MongoDB Cloud Users summary: Create One MongoDB Cloud User 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: description: MongoDB Cloud user account to create. content: application/json: schema: "$ref": "#/components/schemas/CloudAppUser" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudAppUser" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/MongoDB-Cloud-Users/operation/createUser "/api/atlas/v1.0/users/{userId}": get: tags: - MongoDB Cloud Users summary: Return One MongoDB Cloud User by ID description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. operationId: getUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: userId in: path description: Unique 24-hexadecimal digit string that identifies this user. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudAppUser" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/MongoDB-Cloud-Users/operation/getUser "/api/atlas/v1.0/users/byName/{userName}": get: tags: - MongoDB Cloud Users summary: Return One MongoDB Cloud User by Username description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. operationId: getUserByUsername parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: userName in: path description: Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user. 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': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudAppUser" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/MongoDB-Cloud-Users/operation/getUserByUsername "/api/atlas/v1.0/orgs/{orgId}/liveMigrations/linkTokens": post: tags: - Cloud Migration Service summary: Create One Link-Token description: Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. operationId: createLinkToken parameters: - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" requestBody: description: IP address access list entries associated with the migration. content: application/json: schema: "$ref": "#/components/schemas/TargetOrgRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TargetOrg" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/createLinkToken delete: tags: - Cloud Migration Service summary: Remove One Link-Token description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. operationId: deleteLinkToken parameters: - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/envelope" responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/deleteLinkToken "/api/atlas/v1.0/orgs/{orgId}/liveMigrations/availableProjects": get: tags: - Cloud Migration Service summary: Return All Projects Available for Migration description: Return all projects that you can migrate to the specified organization. operationId: listSourceProjects parameters: - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/LiveImportAvailableProject" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/listSourceProjects "/api/atlas/v1.0/groups/{groupId}/liveMigrations": post: tags: - Cloud Migration Service summary: Migrate One Local Managed Cluster to MongoDB Atlas description: |- Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it. You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. operationId: createPushMigration parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" requestBody: description: One migration to be created. content: application/json: schema: "$ref": "#/components/schemas/LiveMigrationRequest" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/LiveMigrationResponse" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/createPushMigration "/api/atlas/v1.0/groups/{groupId}/liveMigrations/{liveMigrationId}": get: tags: - Cloud Migration Service summary: Return One Migration Job description: Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. operationId: getPushMigration parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/liveMigrationId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LiveMigrationResponse" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/getPushMigration "/api/atlas/v1.0/groups/{groupId}/liveMigrations/validate/{validationId}": get: tags: - Cloud Migration Service summary: Return One Migration Validation Job description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. operationId: getValidationStatus parameters: - "$ref": "#/components/parameters/groupId" - name: validationId in: path description: Unique 24-hexadecimal digit string that identifies the validation job. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 507f1f77bcf86cd799439011 - "$ref": "#/components/parameters/envelope" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LiveImportValidation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/getValidationStatus "/api/atlas/v1.0/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover": put: tags: - Cloud Migration Service summary: Cut Over One Migrated Cluster description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. operationId: cutoverMigration parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/liveMigrationId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" responses: '202': "$ref": "#/components/responses/accepted" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/cutoverMigration "/api/atlas/v1.0/groups/{groupId}/liveMigrations/validate": post: tags: - Cloud Migration Service summary: Validate One Migration Request description: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. operationId: validateMigration parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" requestBody: description: One migration to be validated. content: application/json: schema: "$ref": "#/components/schemas/LiveMigrationRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LiveImportValidation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Migration-Service/operation/validateMigration "/api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings": get: tags: - Federated Authentication summary: Return All Role Mappings from One Organization 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: listRoleMappings parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedRoleMappingView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/listRoleMappings post: tags: - Federated Authentication summary: Create One Role Mapping in One Organization Configuration 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: createRoleMapping parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" requestBody: description: The role mapping that you want to create. content: application/json: schema: "$ref": "#/components/schemas/AuthFederationRoleMapping" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AuthFederationRoleMapping" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/createRoleMapping "/api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}": get: tags: - Federated Authentication summary: Return One Role Mapping from One Organization 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: getRoleMapping parameters: - "$ref": "#/components/parameters/federationSettingsId" - name: id in: path description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AuthFederationRoleMapping" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/getRoleMapping put: tags: - Federated Authentication summary: Update One Role Mapping in One Organization 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: updateRoleMapping parameters: - "$ref": "#/components/parameters/federationSettingsId" - name: id in: path description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" requestBody: description: The role mapping that you want to update. content: application/json: schema: "$ref": "#/components/schemas/AuthFederationRoleMapping" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AuthFederationRoleMapping" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/updateRoleMapping delete: tags: - Federated Authentication summary: Remove One Role Mapping from One Organization 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: deleteRoleMapping parameters: - "$ref": "#/components/parameters/federationSettingsId" - name: id in: path description: Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" responses: '204': description: No Content '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/deleteRoleMapping "/api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs": get: tags: - Federated Authentication summary: Return All Organization Configurations from One Federation description: Returns all connected org configs 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 orgs. operationId: listConnectedOrgConfigs parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedConnectedOrgConfigsView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/listConnectedOrgConfigs "/api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}": get: tags: - Federated Authentication summary: Return One Organization Configuration from One Federation description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - name: orgId in: path description: Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ConnectedOrgConfig" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/getConnectedOrgConfig delete: tags: - Federated Authentication summary: Remove One Organization Configuration from One Federation 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: removeConnectedOrgConfig parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - name: orgId in: path description: Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '204': description: This endpoint does not return a response body. content: application/json: {} '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/removeConnectedOrgConfig patch: tags: - Federated Authentication summary: Update One Organization Configuration in One Federation 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: updateConnectedOrgConfig parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - name: orgId in: path description: Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 requestBody: description: The connected organization configuration that you want to update. content: application/json: schema: "$ref": "#/components/schemas/ConnectedOrgConfig" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ConnectedOrgConfig" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/updateConnectedOrgConfig "/api/atlas/v1.0/federationSettings/{federationSettingsId}": delete: tags: - Federated Authentication summary: Delete One Federation Settings Instance 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: deleteFederationApp parameters: - "$ref": "#/components/parameters/federationSettingsId" responses: '204': description: No Content '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/deleteFederationApp "/api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders": get: tags: - Federated Authentication summary: Return All Identity Providers in One Federation 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: listIdentityProviders parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - name: protocol in: query description: The protocols of the target identity providers. schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string default: SAML enum: - SAML - OIDC - name: idpType in: query description: The types of the target identity providers. schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string default: WORKFORCE enum: - WORKFORCE - WORKLOAD responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedFederationIdentityProvider" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/listIdentityProviders "/api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml": get: tags: - Federated Authentication summary: Return Metadata of One Identity Provider 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: getIdentityProviderMetadata parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/identityProviderId" responses: '200': description: OK content: application/json: schema: type: string '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/getIdentityProviderMetadata "/api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}": get: tags: - Federated Authentication summary: Return One Identity Provider by ID description: Returns one SAML identity provider from 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: getIdentityProvider parameters: - "$ref": "#/components/parameters/federationSettingsId" - "$ref": "#/components/parameters/identityProviderId" - "$ref": "#/components/parameters/envelope" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/FederationSamlIdentityProvider" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Federated-Authentication/operation/getIdentityProvider "/api/atlas/v1.0/groups/{groupId}/integrations/{integrationType}": get: tags: - Third-Party Integrations summary: Return One Third-Party Service Integration 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 Organization Owner or Project Owner role. operationId: getThirdPartyIntegration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: integrationType in: path description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. required: true schema: title: Integration Type type: string enum: - PAGER_DUTY - SLACK - DATADOG - NEW_RELIC - OPS_GENIE - VICTOR_OPS - WEBHOOK - HIP_CHAT - PROMETHEUS - MICROSOFT_TEAMS responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ThirdPartyIntegration" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration put: tags: - Third-Party Integrations summary: Update One Third-Party Service Integration 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: updateThirdPartyIntegration parameters: - name: integrationType in: path description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. required: true schema: title: Integration Type type: string enum: - PAGER_DUTY - SLACK - DATADOG - NEW_RELIC - OPS_GENIE - VICTOR_OPS - WEBHOOK - HIP_CHAT - PROMETHEUS - MICROSOFT_TEAMS - "$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: description: Third-party integration that you want to configure for your project. content: application/json: schema: "$ref": "#/components/schemas/ThirdPartyIntegration" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedIntegrationView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration post: tags: - Third-Party Integrations summary: Configure One Third-Party Service Integration 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: createThirdPartyIntegration parameters: - name: integrationType in: path description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. required: true schema: title: Integration Type type: string enum: - PAGER_DUTY - SLACK - DATADOG - NEW_RELIC - OPS_GENIE - VICTOR_OPS - WEBHOOK - HIP_CHAT - PROMETHEUS - MICROSOFT_TEAMS - "$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: description: Third-party integration that you want to configure for your project. content: application/json: schema: "$ref": "#/components/schemas/ThirdPartyIntegration" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedIntegrationView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration delete: tags: - Third-Party Integrations summary: Remove One Third-Party Service Integration 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: deleteThirdPartyIntegration parameters: - name: integrationType in: path description: Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. required: true schema: title: Integration Type type: string enum: - PAGER_DUTY - SLACK - DATADOG - NEW_RELIC - OPS_GENIE - VICTOR_OPS - WEBHOOK - HIP_CHAT - PROMETHEUS - MICROSOFT_TEAMS - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration "/api/atlas/v1.0/groups/{groupId}/integrations": get: tags: - Third-Party Integrations summary: Return All Active Third-Party Service Integrations 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 Organization Owner or Project Owner role. operationId: listThirdPartyIntegrations parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedIntegrationView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations "/api/atlas/v1.0/groups/{groupId}/invites": get: tags: - Projects summary: Return All Project Invitations 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: listProjectInvitations parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: username in: query description: Email address of the user account invited to this project. schema: type: string format: email responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/GroupInvitation" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/listProjectInvitations post: tags: - Projects summary: Invite One MongoDB Cloud User to One Project 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: createProjectInvitation parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/envelope" requestBody: description: Invites one MongoDB Cloud user to join the specified project. content: application/json: schema: "$ref": "#/components/schemas/GroupInvitationRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupInvitation" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/createProjectInvitation patch: tags: - Projects summary: Update One Project Invitation 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: updateProjectInvitation parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" requestBody: description: Updates the details of one pending invitation to the specified project. content: application/json: schema: "$ref": "#/components/schemas/GroupInvitationRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/updateProjectInvitation "/api/atlas/v1.0/groups/{groupId}/invites/{invitationId}": get: tags: - Projects summary: Return One Project Invitation 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: getProjectInvitation parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: invitationId in: path description: Unique 24-hexadecimal digit string that identifies the invitation. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupInvitation" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/getProjectInvitation delete: tags: - Projects summary: Remove One Project Invitation 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. operationId: deleteProjectInvitation parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - name: invitationId in: path description: Unique 24-hexadecimal digit string that identifies the invitation. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/deleteProjectInvitation patch: tags: - Projects summary: Update One Project Invitation by Invitation ID 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: updateProjectInvitationById parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - name: invitationId in: path description: Unique 24-hexadecimal digit string that identifies the invitation. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Updates the details of one pending invitation to the specified project. content: application/json: schema: "$ref": "#/components/schemas/GroupInvitationUpdateRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/updateProjectInvitationById "/api/atlas/v1.0/groups/{groupId}/teams": get: tags: - Teams summary: Return All Teams in One Project 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: listProjectTeams parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedTeamRoleView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/listProjectTeams post: tags: - Teams summary: Add One Team to One Project description: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams operationId: addAllTeamsToProject parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" requestBody: description: Team to add to the specified project. content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/TeamRole" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedTeamRoleView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/addAllTeamsToProject "/api/atlas/v1.0/groups/{groupId}/teams/{teamId}": delete: tags: - Teams summary: Remove One Team from One Project 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. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams operationId: removeProjectTeam parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/removeProjectTeam patch: tags: - Teams summary: Update Team Roles in One Project 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. externalDocs: description: Manage Organization Teams url: https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams operationId: updateTeamRoles parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: teamId in: path description: Unique 24-hexadecimal digit string that identifies the team for which you want to update roles. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: The project roles assigned to the specified team. content: application/json: schema: "$ref": "#/components/schemas/TeamRole" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedTeamRoleView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Teams/operation/updateTeamRoles "/api/atlas/v1.0/orgs/{orgId}/invoices": get: tags: - Invoices summary: Return All Invoices for One Organization 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: listInvoices parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: viewLinkedInvoices in: query description: Flag that indicates whether to return linked invoices in the linkedInvoices field. schema: type: boolean default: true - name: statusNames in: query description: Statuses of the invoice to be retrieved. Omit to return invoices of all statuses. schema: uniqueItems: true type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - PENDING - CLOSED - FORGIVEN - FAILED - PAID - FREE - PREPAID - INVOICED - name: fromDate in: query 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. schema: type: string format: date example: '2023-01-01' - name: toDate in: query 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. schema: type: string format: date example: '2023-01-01' - name: sortBy in: query description: Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result. schema: type: string default: END_DATE enum: - START_DATE - END_DATE - name: orderBy in: query description: Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result. schema: type: string default: desc enum: - desc - asc example: desc responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiInvoiceMetadataView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Invoices/operation/listInvoices "/api/atlas/v1.0/orgs/{orgId}/invoices/{invoiceId}": get: tags: - Invoices summary: Return One Invoice for One Organization 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: getInvoice parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: invoiceId in: path description: Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BillingInvoice" text/csv: schema: type: string 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 '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Invoices/operation/getInvoice "/api/atlas/v1.0/orgs/{orgId}/invoices/{invoiceId}/csv": get: tags: - Invoices summary: Return One Invoice as CSV for One Organization 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: downloadInvoiceCsv parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: invoiceId in: path description: Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. required: true schema: pattern: "[0-9a-f]+" type: string responses: '200': description: OK content: text/csv: schema: type: string 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 '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Invoices/operation/downloadInvoiceCsv "/api/atlas/v1.0/orgs/{orgId}/invoices/pending": get: tags: - Invoices summary: Return All Pending Invoices for One Organization 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: listPendingInvoices parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiInvoiceView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Invoices/operation/listPendingInvoices "/api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}/accessList": get: tags: - Programmatic API Keys summary: Return All Access List Entries for One Organization API Key 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: listApiKeyAccessListsEntries parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiUserAccessListResponseView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries post: tags: - Programmatic API Keys summary: Create One Access List Entry for One Organization API Key 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: createApiKeyAccessList parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Access list entries to be created for the specified organization API key. content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/UserAccessListRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiUserAccessListResponseView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList "/api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}": get: tags: - Programmatic API Keys summary: Return One Access List Entry for One Organization API Key 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: getApiKeyAccessList parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: ipAddress in: path 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 /. required: true schema: 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 example: 192.0.2.0%2F24 - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/UserAccessListResponse" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList delete: tags: - Programmatic API Keys summary: Remove One Access List Entry for One Organization API Key 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: deleteApiKeyAccessListEntry parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: ipAddress in: path 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 /. required: true schema: 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 example: 192.0.2.0%2F24 responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry "/api/atlas/v1.0/orgs/{orgId}/apiKeys": get: tags: - Programmatic API Keys summary: Return All Organization API Keys 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: listApiKeys parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiApiUserView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/listApiKeys post: tags: - Programmatic API Keys summary: Create One Organization API Key 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: createApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" requestBody: description: Organization API Key to be created. content: application/json: schema: "$ref": "#/components/schemas/CreateAtlasOrganizationApiKey" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiKeyUserDetails" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/createApiKey "/api/atlas/v1.0/orgs/{orgId}/apiKeys/{apiUserId}": get: tags: - Programmatic API Keys summary: Return One Organization API Key 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: getApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiKeyUserDetails" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/getApiKey delete: tags: - Programmatic API Keys summary: Remove One Organization API Key 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: deleteApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/deleteApiKey patch: tags: - Programmatic API Keys summary: Update One Organization API Key description: Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key operationId: updateApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key you want to update. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Organization API key to be updated. This request requires a minimum of one of the two body parameters. content: application/json: schema: "$ref": "#/components/schemas/UpdateAtlasOrganizationApiKey" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiKeyUserDetails" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/updateApiKey "/api/atlas/v1.0/orgs/{orgId}/invites": get: tags: - Organizations summary: Return All Organization Invitations 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. operationId: listOrganizationInvitations parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: username in: query description: Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations. schema: type: string format: email responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/OrganizationInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/listOrganizationInvitations post: tags: - Organizations summary: Invite One MongoDB Cloud User to One Atlas Organization 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. operationId: createOrganizationInvitation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" requestBody: description: Invites one MongoDB Cloud user to join the specified organization. content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitationRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/createOrganizationInvitation patch: tags: - Organizations summary: Update One Organization Invitation 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. operationId: updateOrganizationInvitation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" requestBody: description: Updates the details of one pending invitation to the specified organization. content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitationRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/updateOrganizationInvitation "/api/atlas/v1.0/orgs/{orgId}/invites/{invitationId}": get: tags: - Organizations summary: Return One Organization Invitation 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. operationId: getOrganizationInvitation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - name: invitationId in: path description: Unique 24-hexadecimal digit string that identifies the invitation. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/getOrganizationInvitation delete: tags: - Organizations summary: Remove One Organization Invitation 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. operationId: deleteOrganizationInvitation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: invitationId in: path description: Unique 24-hexadecimal digit string that identifies the invitation. required: true schema: type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/deleteOrganizationInvitation patch: tags: - Organizations summary: Update One Organization Invitation by Invitation ID 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. operationId: updateOrganizationInvitationById parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/orgId" - "$ref": "#/components/parameters/pretty" - name: invitationId in: path description: Unique 24-hexadecimal digit string that identifies the invitation. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Updates the details of one pending invitation to the specified organization. content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitationUpdateRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/OrganizationInvitation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Organizations/operation/updateOrganizationInvitationById "/api/atlas/v1.0/groups/{groupId}/apiKeys/{apiUserId}": post: tags: - Programmatic API Keys summary: Assign One Organization API Key to One Project 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: addProjectApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - "$ref": "#/components/parameters/pretty" requestBody: description: Organization API key to be assigned to the specified project. content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/UserAccessRoleAssignment" required: true responses: '204': description: This endpoint does not return a response body. content: application/json: {} '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/addProjectApiKey delete: tags: - Programmatic API Keys summary: Unassign One Organization API Key from One Project 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. externalDocs: description: Programmatic API Keys url: https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key operationId: removeProjectApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - "$ref": "#/components/parameters/pretty" responses: '204': description: This endpoint does not return a response body. content: application/json: {} '400': "$ref": "#/components/responses/badRequest" '404': "$ref": "#/components/responses/notFound" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/removeProjectApiKey patch: tags: - Programmatic API Keys summary: Update Organization API Key Roles for One Project description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. operationId: updateApiKeyRoles parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/envelope" - name: apiUserId in: path description: Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Organization API Key to be updated. This request requires a minimum of one of the two body parameters. content: application/json: schema: "$ref": "#/components/schemas/UpdateAtlasProjectApiKey" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiKeyUserDetails" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles "/api/atlas/v1.0/groups/{groupId}/apiKeys": get: tags: - Programmatic API Keys summary: Return All Organization API Keys Assigned to One Project 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: listProjectApiKeys parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiApiUserView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/listProjectApiKeys post: tags: - Programmatic API Keys summary: Create and Assign One Organization API Key to One Project 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. operationId: createProjectApiKey parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Organization API key to be created and assigned to the specified project. content: application/json: schema: "$ref": "#/components/schemas/CreateAtlasProjectApiKey" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiKeyUserDetails" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Programmatic-API-Keys/operation/createProjectApiKey "/api/atlas/v1.0/groups/{groupId}/awsCustomDNS": get: tags: - AWS Clusters DNS summary: Return One Custom DNS Configuration for Atlas Clusters on AWS 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: getAwsCustomDns parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AWSCustomDNSEnabledView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns patch: tags: - AWS Clusters DNS summary: Update State of One Custom DNS Configuration for Atlas Clusters on AWS 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: toggleAwsCustomDns parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Enables or disables the custom DNS configuration for AWS clusters in the specified project. content: application/json: schema: "$ref": "#/components/schemas/AWSCustomDNSEnabledView" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AWSCustomDNSEnabledView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns "/api/atlas/v1.0/groups/{groupId}/auditLog": get: tags: - Auditing summary: Return Auditing Configuration for One Project 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: getAuditingConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AuditLog" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Auditing/operation/getAuditingConfiguration patch: tags: - Auditing summary: Update Auditing Configuration for One Project 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: updateAuditingConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Updated auditing configuration for the specified project. content: application/json: schema: "$ref": "#/components/schemas/AuditLog" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AuditLog" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Auditing/operation/updateAuditingConfiguration "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backupCheckpoints": get: tags: - Legacy Backup summary: Return All Legacy Backup Checkpoints 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: listLegacyBackupCheckpoints parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the checkpoints that you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAtlasCheckpointView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}": get: tags: - Legacy Backup summary: Return One Legacy Backup Checkpoint 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: getLegacyBackupCheckpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: checkpointId in: path description: Unique 24-hexadecimal digit string that identifies the checkpoint. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the checkpoints that you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiAtlasCheckpointView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint "/api/atlas/v1.0/groups/{groupId}/cloudProviderAccess": get: tags: - Cloud Provider Access summary: Return All Cloud Provider Access Roles 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: listCloudProviderAccessRoles parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderAccessRoles" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles post: tags: - Cloud Provider Access summary: Create One Cloud Provider Access Role 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: createCloudProviderAccessRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Creates one role for the specified cloud provider. content: application/json: schema: "$ref": "#/components/schemas/CloudProviderAccessRoleRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderAccessRole" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole "/api/atlas/v1.0/groups/{groupId}/cloudProviderAccess/{roleId}": get: tags: - Cloud Provider Access summary: Return One Cloud Provider Access Role 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: getCloudProviderAccessRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: roleId in: path description: Unique 24-hexadecimal digit string that identifies the role. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderAccessRole" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole patch: tags: - Cloud Provider Access summary: Authorize One Cloud Provider Access Role 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: authorizeCloudProviderAccessRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: roleId in: path description: Unique 24-hexadecimal digit string that identifies the role. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Grants access to the specified project for the specified access role. content: application/json: schema: "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderAccessRole" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole "/api/atlas/v1.0/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}": delete: tags: - Cloud Provider Access summary: Deauthorize One Cloud Provider Access Role 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: deauthorizeCloudProviderAccessRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Human-readable label that identifies the cloud provider of the role to deauthorize. required: true schema: type: string enum: - AWS - AZURE - GCP - name: roleId in: path description: Unique 24-hexadecimal digit string that identifies the role. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: No Content '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole "/api/atlas/v1.0/groups/{groupId}/containers": get: tags: - Network Peering summary: Return All Network Peering Containers in One Project for One Cloud Provider 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: listPeeringContainerByCloudProvider parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: providerName in: query description: Cloud service provider that serves the desired network peering containers. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedCloudProviderContainerView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider post: tags: - Network Peering summary: Create One Network Peering Container 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: createPeeringContainer parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Creates one new network peering container in the specified project. content: application/json: schema: "$ref": "#/components/schemas/CloudProviderContainer" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderContainer" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/createPeeringContainer "/api/atlas/v1.0/groups/{groupId}/containers/{containerId}": get: tags: - Network Peering summary: Return One Network Peering Container 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: getPeeringContainer parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: containerId in: path description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderContainer" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/getPeeringContainer delete: tags: - Network Peering summary: Remove One Network Peering Container 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: deletePeeringContainer parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: containerId in: path description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/deletePeeringContainer patch: tags: - Network Peering summary: Update One Network Peering Container 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: updatePeeringContainer parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: containerId in: path description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 requestBody: description: Updates the network details and labels of one specified network peering container in the specified project. content: application/json: schema: "$ref": "#/components/schemas/CloudProviderContainer" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudProviderContainer" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/updatePeeringContainer "/api/atlas/v1.0/groups/{groupId}/containers/all": get: tags: - Network Peering summary: Return All Network Peering Containers in One Project 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: listPeeringContainers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedCloudProviderContainerView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/listPeeringContainers "/api/atlas/v1.0/groups/{groupId}/clusters/provider/regions": get: tags: - Clusters summary: Return All Cloud Provider Regions 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: listCloudProviderRegions parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: providers in: query 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. schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string - name: tier in: query description: Cluster tier for which to retrieve the regions. schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAtlasProviderRegionsView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/listCloudProviderRegions "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/status": get: tags: - Clusters summary: Return Status of All Cluster Operations 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: getClusterStatus parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterStatus" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/getClusterStatus "/api/atlas/v1.5/groups/{groupId}/clusters": get: tags: - Multi-Cloud Clusters summary: Return All Clusters in One Project description: |- Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting 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 [createCluster](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 listFlexClusters endpoint for Flex clusters instead. externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters operationId: listClusters parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: includeDeletedWithRetainedBackups in: query description: Flag that indicates whether to return Clusters with retain backups. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAdvancedClusterDescriptionView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Multi-Cloud-Clusters/operation/listClusters post: tags: - Multi-Cloud Clusters summary: Create One Cluster in One Project description: |- Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create multi-cloud clusters. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner 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 createFlexCluster API for such configurations moving forward. externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster operationId: createCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Cluster to create in this project. content: application/json: schema: "$ref": "#/components/schemas/AdvancedClusterDescription" examples: Multi Cloud Cluster: description: Multi Cloud Cluster value: name: multiCloud clusterType: REPLICASET replicationSpecs: - numShards: 1 regionConfigs: - analyticsAutoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M40 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true analyticsSpecs: instanceSize: M30 nodeCount: 0 autoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M40 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true providerName: AWS electableSpecs: instanceSize: M30 nodeCount: 3 hiddenSecondarySpecs: instanceSize: M30 nodeCount: 0 priority: 7 readOnlySpecs: instanceSize: M30 nodeCount: 0 regionName: US_EAST_1 - analyticsAutoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M40 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true analyticsSpecs: instanceSize: M30 nodeCount: 0 autoScaling: autoIndexing: enabled: false compute: enabled: true maxInstanceSize: M40 minInstanceSize: M30 scaleDownEnabled: true diskGB: enabled: true providerName: GCP electableSpecs: instanceSize: M30 nodeCount: 2 hiddenSecondarySpecs: instanceSize: M30 nodeCount: 0 priority: 6 readOnlySpecs: instanceSize: M30 nodeCount: 0 regionName: EASTERN_US zoneName: Zone 1 links: [] required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/AdvancedClusterDescription" '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" '500': "$ref": "#/components/responses/internalServerError" 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/v1/#tag/Multi-Cloud-Clusters/operation/createCluster "/api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}": get: tags: - Multi-Cloud Clusters summary: Return One Cluster from One Project description: |- Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting 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 [createCluster](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 getFlexCluster endpoint for Flex clusters instead. externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster operationId: getCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AdvancedClusterDescription" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Multi-Cloud-Clusters/operation/getCluster delete: tags: - Multi-Cloud Clusters summary: Remove One Cluster from One Project 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 [createCluster](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 deleteFlexCluster endpoint for Flex clusters instead. externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster operationId: deleteCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: retainBackups in: query description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. schema: type: boolean responses: '202': description: Accepted '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Multi-Cloud-Clusters/operation/deleteCluster patch: tags: - Multi-Cloud Clusters summary: Update One Cluster in One Project description: 'Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update multi-cloud clusters. To update a cluster''s termination protection, the requesting 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. 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.' operationId: updateCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Cluster to update in the specified project. content: application/json: schema: "$ref": "#/components/schemas/AdvancedClusterDescription" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/AdvancedClusterDescription" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" 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/v1/#tag/Multi-Cloud-Clusters/operation/updateCluster "/api/atlas/v1.5/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz": get: tags: - Monitoring and Logs summary: Download Logs for One Cluster Host in One Project 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 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".' operationId: getHostLogs parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: hostName in: path description: Human-readable label that identifies the host that stores the log files that you want to download. 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 - name: logName in: path 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. required: true schema: type: string externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ enum: - mongodb - mongos - mongodb-audit-log - mongos-audit-log - name: endDate in: query 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. schema: minimum: 1199145600 type: integer format: int64 - name: startDate in: query 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. schema: minimum: 1199145600 type: integer format: int64 responses: '200': description: OK content: application/gzip: schema: type: string description: Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project format: binary '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getHostLogs "/api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping": delete: tags: - Global Clusters summary: Remove All Custom Zone Mappings from One Global Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: deleteAllCustomZoneMappings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings "/api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces": delete: tags: - Global Clusters summary: Remove One Managed Namespace from One Global Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: deleteManagedNamespace parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - "$ref": "#/components/parameters/groupId" - name: db in: query description: Human-readable label that identifies the database that contains the collection. schema: type: string - name: collection in: query description: Human-readable label that identifies the collection associated with the managed namespace. schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/deleteManagedNamespace "/api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}/restartPrimaries": post: tags: - Multi-Cloud Clusters summary: Test Failover for One Cluster 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. operationId: testFailover parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Multi-Cloud-Clusters/operation/testFailover "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/outageSimulation": get: tags: - Cluster Outage Simulation summary: Return One Outage Simulation description: Returns one outage simulation for one cluster. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage operationId: getOutageSimulation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster that is undergoing outage simulation. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterOutageSimulation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation post: tags: - Cluster Outage Simulation summary: Start One Outage Simulation description: Starts a cluster outage simulation. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage operationId: startOutageSimulation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster to undergo an outage simulation. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Describes the outage simulation. content: application/json: schema: "$ref": "#/components/schemas/ClusterOutageSimulation" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterOutageSimulation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation delete: tags: - Cluster Outage Simulation summary: End One Outage Simulation description: Ends a cluster outage simulation. externalDocs: description: Cluster Outage Simulation url: https://dochub.mongodb.org/core/test-regional-outage operationId: endOutageSimulation parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster that is undergoing outage simulation. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterOutageSimulation" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/index": post: tags: - Rolling Index summary: Create One Rolling Index 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. externalDocs: description: Rolling Index Builds on Replica Sets url: https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/ operationId: createRollingIndex parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster on which MongoDB Cloud creates an index. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Rolling index to create on the specified cluster. content: application/json: schema: "$ref": "#/components/schemas/DatabaseRollingIndexRequest" 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 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 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 required: true responses: '202': description: Accepted '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" 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. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Rolling-Index/operation/createRollingIndex "/api/atlas/v1.0/groups/{groupId}/customDBRoles/roles": get: tags: - Custom Database Roles summary: Return All Custom Roles in One Project 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: listCustomDatabaseRoles parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/UserCustomDBRole" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles post: tags: - Custom Database Roles summary: Create One Custom Role 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: createCustomDatabaseRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Creates one custom role in the specified project. content: application/json: schema: "$ref": "#/components/schemas/UserCustomDBRole" required: true responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/UserCustomDBRole" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole "/api/atlas/v1.0/groups/{groupId}/customDBRoles/roles/{roleName}": get: tags: - Custom Database Roles summary: Return One Custom Role in One Project 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: getCustomDatabaseRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: roleName in: path description: Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. required: true schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/UserCustomDBRole" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole delete: tags: - Custom Database Roles summary: Remove One Custom Role from One Project 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: deleteCustomDatabaseRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: roleName in: path description: Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. required: true schema: type: string responses: '204': description: No Content '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole patch: tags: - Custom Database Roles summary: Update One Custom Role in One Project 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: updateCustomDatabaseRole parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: roleName in: path description: Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project. required: true schema: type: string requestBody: description: Updates one custom role in the specified project. content: application/json: schema: "$ref": "#/components/schemas/UpdateCustomDBRole" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/UserCustomDBRole" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole "/api/atlas/v1.0/groups/{groupId}/dataFederation": get: tags: - Data Federation summary: Return All Federated Database Instances in One Project 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: listFederatedDatabases parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: type in: query description: Type of Federated Database Instances to return. schema: type: string default: USER enum: - USER - ONLINE_ARCHIVE responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DataLakeTenant" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/listFederatedDatabases post: tags: - Data Federation summary: Create One Federated Database Instance in One Project 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: createFederatedDatabase parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: skipRoleValidation in: query 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. schema: type: boolean default: false requestBody: description: Details to create one federated database instance in the specified project. content: application/json: schema: "$ref": "#/components/schemas/DataLakeTenant" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeTenant" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/createFederatedDatabase "/api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName}": get: tags: - Data Federation summary: Return One Federated Database Instance in One Project 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: getFederatedDatabase parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: tenantName in: path description: Human-readable label that identifies the Federated Database to return. required: true schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeTenant" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/getFederatedDatabase delete: tags: - Data Federation summary: Remove One Federated Database Instance from One Project 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: deleteFederatedDatabase parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: tenantName in: path description: Human-readable label that identifies the federated database instance to remove. required: true schema: type: string responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/deleteFederatedDatabase patch: tags: - Data Federation summary: Update One Federated Database Instance in One Project 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: updateFederatedDatabase parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: tenantName in: path description: Human-readable label that identifies the federated database instance to update. required: true schema: type: string - name: skipRoleValidation in: query 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. required: true schema: type: boolean requestBody: description: Details of one Federated Database to update in the specified project. content: application/json: schema: "$ref": "#/components/schemas/DataLakeTenant" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeTenant" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/updateFederatedDatabase "/api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}": get: tags: - Data Federation summary: Return One Federated Database Instance Query Limit for One Project 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: returnFederatedDatabaseQueryLimit parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: tenantName in: path description: Human-readable label that identifies the federated database instance to which the query limit applies. required: true schema: type: string - name: limitName in: path 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 | required: true schema: type: string enum: - bytesProcessed.query - bytesProcessed.daily - bytesProcessed.weekly - bytesProcessed.monthly responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataFederationTenantQueryLimit" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit delete: tags: - Data Federation summary: Delete One Query Limit for One Federated Database Instance 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: deleteOneDataFederationInstanceQueryLimit parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: tenantName in: path description: Human-readable label that identifies the federated database instance to which the query limit applies. required: true schema: type: string - name: limitName in: path 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 | required: true schema: type: string enum: - bytesProcessed.query - bytesProcessed.daily - bytesProcessed.weekly - bytesProcessed.monthly responses: '204': description: This endpoint does not return a response body. content: application/json: {} '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit patch: tags: - Data Federation summary: Configure One Query Limit for One Federated Database Instance 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: createOneDataFederationQueryLimit parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: tenantName in: path description: Human-readable label that identifies the federated database instance to which the query limit applies. required: true schema: type: string - name: limitName in: path 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 | required: true schema: type: string enum: - bytesProcessed.query - bytesProcessed.daily - bytesProcessed.weekly - bytesProcessed.monthly requestBody: description: Creates or updates one query limit for one federated database instance. content: application/json: schema: "$ref": "#/components/schemas/DataFederationTenantQueryLimit" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataFederationTenantQueryLimit" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/createOneDataFederationQueryLimit "/api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName}/limits": get: tags: - Data Federation summary: Return All Query Limits for One Federated Database Instance 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: returnFederatedDatabaseQueryLimits parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: tenantName in: path description: Human-readable label that identifies the federated database instance for which you want to retrieve query limits. required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DataFederationTenantQueryLimit" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits "/api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz": get: tags: - Data Federation summary: Download Query Logs for One Federated Database Instance 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/gzip".' operationId: downloadFederatedDatabaseQueryLogs parameters: - "$ref": "#/components/parameters/groupId" - name: endDate in: query 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. schema: pattern: '1199145600' type: integer format: int64 example: 1636481348 - name: startDate in: query 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. schema: pattern: '1199145600' type: integer format: int64 example: 1636466948 - name: tenantName in: path description: Human-readable label that identifies the federated database instance for which you want to download query logs. required: true schema: type: string responses: '200': description: OK content: application/gzip: schema: type: string description: Compressed archive labeled `queryLogs.gz` downloads format: binary '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs "/api/atlas/v1.0/groups/{groupId}/pipelines": get: tags: - Data Lake Pipelines summary: Return All Data Lake Pipelines in One Project 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: listPipelines parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DataLakeIngestionPipeline" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/listPipelines post: tags: - Data Lake Pipelines summary: Create One Data Lake Pipeline 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: createPipeline parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" requestBody: description: Creates one Data Lake Pipeline. content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/createPipeline "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}": get: tags: - Data Lake Pipelines summary: Return One Data Lake Pipeline 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: getPipeline parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/getPipeline delete: tags: - Data Lake Pipelines summary: Remove One Data Lake Pipeline description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: {} '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/deletePipeline patch: tags: - Data Lake Pipelines summary: Update One Data Lake Pipeline description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string requestBody: description: Updates one Data Lake Pipeline. content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/updatePipeline "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}": get: tags: - Data Lake Pipelines summary: Return One Data Lake Pipeline Run 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: getPipelineRun parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string - name: pipelineRunId in: path description: Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/IngestionPipelineRun" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/getPipelineRun delete: tags: - Data Lake Pipelines summary: Delete One Pipeline Run Dataset description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string - name: pipelineRunId in: path description: Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/RequestAccepted" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/availableSchedules": get: tags: - Data Lake Pipelines summary: Return All Ingestion Schedules for One Data Lake Pipeline 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: listPipelineSchedules parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DiskBackupApiPolicyItem" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots": get: tags: - Data Lake Pipelines summary: Return All Backup Snapshots for One Data Lake Pipeline 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: listPipelineSnapshots parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: completedAfter in: query 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. schema: type: string format: date-time - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedBackupSnapshotView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/runs": get: tags: - Data Lake Pipelines summary: Return All Data Lake Pipeline Runs in One Project 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: listPipelineRuns parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: createdBefore in: query description: If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date. schema: type: string format: date-time - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedPipelineRunView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/listPipelineRuns "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/pause": post: tags: - Data Lake Pipelines summary: Pause One Data Lake Pipeline 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: pausePipeline parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/pausePipeline "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/resume": post: tags: - Data Lake Pipelines summary: Resume One Data Lake Pipeline 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: resumePipeline parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataLakeIngestionPipeline" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/resumePipeline "/api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/trigger": post: tags: - Data Lake Pipelines summary: Trigger On-Demand Snapshot Ingestion description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: pipelineName in: path description: Human-readable label that identifies the Data Lake Pipeline. required: true schema: pattern: ^[^/\\ "$]{1,64}$ type: string requestBody: description: Triggers a single ingestion run of a snapshot. content: application/json: schema: "$ref": "#/components/schemas/TriggerIngestionPipelineRequest" required: true x-sunset: '2025-09-09' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/IngestionPipelineRun" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion "/api/atlas/v1.0/groups/{groupId}/databaseUsers": get: tags: - Database Users summary: Return All Database Users in One Project 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: listDatabaseUsers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAtlasDatabaseUserView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Database-Users/operation/listDatabaseUsers post: tags: - Database Users summary: Create One Database User in One Project 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: createDatabaseUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Creates one database user in the specified project. content: application/json: schema: "$ref": "#/components/schemas/CloudDatabaseUser" examples: AWS IAM Authentication: description: AWS IAM Authentication value: databaseName: "$external" awsIAMType: USER roles: - databaseName: sales roleName: readWrite - databaseName: marketing roleName: read scopes: - name: myCluster type: CLUSTER groupId: 32b6e34b3d91647abb20e7b8 username: arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user LDAP Authentication: description: LDAP Authentication value: databaseName: admin ldapAuthType: GROUP roles: - databaseName: sales roleName: readWrite - databaseName: marketing roleName: read scopes: - name: myCluster type: CLUSTER groupId: 32b6e34b3d91647abb20e7b8 username: CN=marketing,OU=groups,DC=example,DC=com SCRAM-SHA Authentication: description: SCRAM-SHA Authentication value: databaseName: admin password: changeme123 roles: - databaseName: sales roleName: readWrite - databaseName: marketing roleName: read scopes: - name: myCluster type: CLUSTER groupId: 32b6e34b3d91647abb20e7b8 username: david X509 Authentication: description: X509 Authentication value: databaseName: "$external" x509Type: CUSTOMER roles: - databaseName: sales roleName: readWrite - databaseName: marketing roleName: read scopes: - name: myCluster type: CLUSTER groupId: 32b6e34b3d91647abb20e7b8 username: CN=david@example.com,OU=users,DC=example,DC=com OIDC Workforce Federated Authentication: description: OIDC Workforce Federated Authentication value: databaseName: admin oidcAuthType: IDP_GROUP roles: - databaseName: sales roleName: readWrite - databaseName: marketing roleName: read scopes: - name: myCluster type: CLUSTER groupId: 32b6e34b3d91647abb20e7b8 username: 5dd7496c7a3e5a648454341c/sales OIDC Workload Federated Authentication: description: OIDC Workload Federated Authentication value: databaseName: "$external" oidcAuthType: USER roles: - databaseName: sales roleName: readWrite - databaseName: marketing roleName: read scopes: - name: myCluster type: CLUSTER groupId: 32b6e34b3d91647abb20e7b8 username: 5dd7496c7a3e5a648454341c/sales required: true responses: '201': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudDatabaseUser" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Database-Users/operation/createDatabaseUser "/api/atlas/v1.0/groups/{groupId}/databaseUsers/{databaseName}/{username}": get: tags: - Database Users summary: Return One Database User from One Project 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: getDatabaseUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: databaseName in: path 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`. required: true schema: type: string - name: username in: path 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 | ARN | | AWS IAM | awsIAMType | USER | ARN | | 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 | required: true schema: type: string example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudDatabaseUser" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Database-Users/operation/getDatabaseUser delete: tags: - Database Users summary: Remove One Database User from One Project 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: deleteDatabaseUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: databaseName in: path 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`. required: true schema: type: string - name: username in: path 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 | ARN | | AWS IAM | awsIAMType | USER | ARN | | 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 | required: true schema: type: string example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Database-Users/operation/deleteDatabaseUser patch: tags: - Database Users summary: Update One Database User in One Project 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: updateDatabaseUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: databaseName in: path 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`. required: true schema: type: string - name: username in: path 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 | ARN | | AWS IAM | awsIAMType | USER | ARN | | 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 | required: true schema: type: string example: 'SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' requestBody: description: Updates one database user that belongs to the specified project. content: application/json: schema: "$ref": "#/components/schemas/CloudDatabaseUser" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudDatabaseUser" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Database-Users/operation/updateDatabaseUser "/api/atlas/v1.0/groups/{groupId}/databaseUsers/{username}/certs": get: tags: - X.509 Authentication summary: Return All X.509 Certificates Assigned to One Database User 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: listDatabaseUserCertificates parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: username in: path description: Human-readable label that represents the MongoDB database user account whose certificates you want to return. required: true schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedUserCertView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/X.509-Authentication/operation/listDatabaseUserCertificates post: tags: - X.509 Authentication summary: Create One X.509 Certificate for One Database User 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: createDatabaseUserCertificate parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: username in: path description: Human-readable label that represents the MongoDB database user account for whom to create a certificate. required: true schema: type: string requestBody: description: Generates one X.509 certificate for the specified MongoDB user. content: application/json: schema: "$ref": "#/components/schemas/UserCert" required: true responses: '201': description: This endpoint returns a PEM file with the certificate and private key. content: application/json: schema: type: string description: PEM file that contains the user's X.509 certificate and private key. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/X.509-Authentication/operation/createDatabaseUserCertificate "/api/atlas/v1.0/groups/{groupId}/backup/exportBuckets": get: tags: - Cloud Backups summary: Return All Snapshot Export Buckets 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 or Project Backup Manager role. operationId: listExportBuckets parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedBackupSnapshotExportBucketView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listExportBuckets post: tags: - Cloud Backups summary: Create One Snapshot Export Bucket description: Creates an Export Bucket for a given AWS S3 Bucket. Once created, snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: createExportBucket parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Specifies the AWS S3 Bucket and IAM role that the Export Bucket should reference. content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucketRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/createExportBucket "/api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId}": get: tags: - Cloud Backups summary: Return One Snapshot Export Bucket 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 or Project Backup Manager role. operationId: getExportBucket parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: exportBucketId in: path description: Unique 24-hexadecimal character string that identifies the Export Bucket. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse" examples: AWS: description: AWS value: _id: 32b6e34b3d91647abb20e7b8 cloudProvider: AWS bucketName: export-bucket iamRoleId: 668c5f0ed436263134491592 links: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getExportBucket delete: tags: - Cloud Backups summary: Delete One Snapshot Export Bucket 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: deleteExportBucket parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: exportBucketId in: path description: Unique 24-hexadecimal character string that identifies the Export Bucket. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/deleteExportBucket "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports": get: tags: - Cloud Backups summary: Return All Snapshot Export Jobs 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: listBackupExportJobs parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listBackupExportJobs post: tags: - Cloud Backups summary: Create One Snapshot Export Job 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 Atlas Admin role. operationId: createBackupExportJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Information about the Cloud Backup Snapshot Export Job to create. content: application/json: schema: "$ref": "#/components/schemas/DiskBackupExportJobRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupExportJob" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/createBackupExportJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}": get: tags: - Cloud Backups summary: Return One Snapshot Export Job 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: getBackupExportJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: exportId in: path description: Unique 24-hexadecimal character string that identifies the Export Job. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupExportJob" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getBackupExportJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}": get: tags: - Cloud Backups summary: Return One Restore Job for One Cluster 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: getBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster with the restore jobs you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: restoreJobId in: path description: Unique 24-hexadecimal digit string that identifies the restore job to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getBackupRestoreJob delete: tags: - Cloud Backups summary: Cancel One Restore Job for One Cluster 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. operationId: cancelBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: restoreJobId in: path description: Unique 24-hexadecimal digit string that identifies the restore job to remove. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '405': "$ref": "#/components/responses/methodNotAllowed" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/cancelBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs": get: tags: - Cloud Backups summary: Return All Restore Jobs for One Cluster 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: listBackupRestoreJobs parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster with the restore jobs you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedCloudBackupRestoreJobView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listBackupRestoreJobs post: tags: - Cloud Backups summary: Restore One Snapshot of One Cluster description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: createBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Restores one snapshot of one cluster from the specified project. content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/createBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/schedule": get: tags: - Cloud Backups summary: Return One Cloud Backup Schedule 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. operationId: getBackupSchedule parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getBackupSchedule delete: tags: - Cloud Backups summary: Remove All Cloud Backup Schedules 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. operationId: deleteAllBackupSchedules parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/deleteAllBackupSchedules patch: tags: - Cloud Backups summary: Update Cloud Backup Schedule for One Cluster 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. operationId: updateBackupSchedule parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: 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. content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/updateBackupSchedule "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}": get: tags: - Cloud Backups summary: Return One Sharded Cluster Cloud Backup 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: getShardedClusterBackup parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshot" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getShardedClusterBackup delete: tags: - Cloud Backups summary: Remove One Sharded Cluster Cloud Backup 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: deleteShardedClusterBackup parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/deleteShardedClusterBackup "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}": get: tags: - Cloud Backups summary: Return One Replica Set Cloud Backup 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: getReplicaSetBackup parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupReplicaSet" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getReplicaSetBackup delete: tags: - Cloud Backups summary: Remove One Replica Set Cloud Backup description: Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: deleteReplicaSetBackup parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/deleteReplicaSetBackup patch: tags: - Cloud Backups summary: Update Expiration Date for One Cloud Backup 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: updateSnapshotRetention parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. content: application/json: schema: "$ref": "#/components/schemas/BackupSnapshotRetention" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupReplicaSet" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/updateSnapshotRetention "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters": get: tags: - Cloud Backups summary: Return All Sharded Cluster Cloud Backups 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: listShardedClusterBackups parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listShardedClusterBackups "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots": get: tags: - Cloud Backups summary: Return All Replica Set Cloud Backups 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: listReplicaSetBackups parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedCloudBackupReplicaSetView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listReplicaSetBackups post: tags: - Cloud Backups summary: Take One On-Demand Snapshot description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: takeSnapshot parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Takes one on-demand snapshot. content: application/json: schema: "$ref": "#/components/schemas/DiskBackupOnDemandSnapshotRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DiskBackupSnapshot" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/takeSnapshot "/api/atlas/v1.0/groups/{groupId}/encryptionAtRest": get: tags: - Encryption at Rest using Customer Key Management summary: Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project 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: getEncryptionAtRest parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/EncryptionAtRest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest patch: tags: - Encryption at Rest using Customer Key Management summary: Update Encryption at Rest Configuration for One Project 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: updateEncryptionAtRest parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" requestBody: description: |- Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management: If you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider. - To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object. - To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object. - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object. If you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint. content: application/json: schema: "$ref": "#/components/schemas/EncryptionAtRest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/EncryptionAtRest" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes": post: tags: - Atlas Search summary: Create One Atlas Search Index 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: createAtlasSearchIndexDeprecated parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the collection on which to create an Atlas Search index. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Creates one Atlas Search index on the specified collection. content: application/json: schema: "$ref": "#/components/schemas/ClusterSearchIndex" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterSearchIndex" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}": get: tags: - Atlas Search summary: Return One Atlas Search Index 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: getAtlasSearchIndexDeprecated parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the collection with one or more Atlas Search indexes. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: indexId in: path 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. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterSearchIndex" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated delete: tags: - Atlas Search summary: Remove One Atlas Search Index 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: deleteAtlasSearchIndexDeprecated parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the database and collection with one or more Application Search indexes. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: indexId in: path 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. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated patch: tags: - Atlas Search summary: Update One Atlas Search Index 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: updateAtlasSearchIndexDeprecated parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the collection whose Atlas Search index to update. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: indexId in: path 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. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Details to update on the Atlas Search index. content: application/json: schema: "$ref": "#/components/schemas/ClusterSearchIndex" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterSearchIndex" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers": get: tags: - Atlas Search summary: Return All User-Defined Analyzers for One Cluster description: Returns all Atlas Search custom analyzers that the specified cluster uses in the specified project. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. externalDocs: description: Custom Analyzers url: https://dochub.mongodb.org/core/custom-fts operationId: listAnalyzers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the collection with one or more Atlas Search indexes. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/listAnalyzers put: tags: - Atlas Search summary: Update All User-Defined Analyzers for One Cluster description: Updates one or more Atlas Search custom analyzers on the specified cluster. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: description: Custom Analyzers url: https://dochub.mongodb.org/core/custom-fts operationId: updateAllAnalyzers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the collection with one or more Atlas Search indexes. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Updates one or more Atlas Search custom analyzers on the specified cluster. content: application/json: schema: type: array items: "$ref": "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" required: true responses: '200': description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" '400': "$ref": "#/components/responses/badRequest" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/updateAllAnalyzers "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}": get: tags: - Atlas Search summary: Return All Atlas Search Indexes for One Collection 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: listAtlasSearchIndexesDeprecated parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Name of the cluster that contains the collection with one or more Atlas Search indexes. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: collectionName in: path description: Name of the collection that contains one or more Atlas Search indexes. required: true schema: type: string - name: databaseName in: path description: Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ClusterSearchIndex" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated "/api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements": get: tags: - Monitoring and Logs summary: Return Atlas Search Metrics for One Index in One Namespace description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. operationId: getIndexMetrics parameters: - "$ref": "#/components/parameters/processId" - "$ref": "#/components/parameters/indexName" - "$ref": "#/components/parameters/databaseName" - "$ref": "#/components/parameters/collectionName" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/granularity" - "$ref": "#/components/parameters/period" - "$ref": "#/components/parameters/start" - "$ref": "#/components/parameters/end" - "$ref": "#/components/parameters/envelope" - name: metrics in: query description: List that contains the measurements that MongoDB Atlas reports for the associated data series. required: true style: form schema: maxItems: 10 uniqueItems: true type: array description: List that contains the measurements that MongoDB Atlas reports for the associated data series. items: type: string enum: - INDEX_SIZE_ON_DISK - NUMBER_OF_DELETES - NUMBER_OF_ERROR_QUERIES - NUMBER_OF_GETMORE_COMMANDS - NUMBER_OF_INDEX_FIELDS - NUMBER_OF_INSERTS - NUMBER_OF_SUCCESS_QUERIES - NUMBER_OF_UPDATES - REPLICATION_LAG - TOTAL_NUMBER_OF_QUERIES responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MeasurementsIndexes" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getIndexMetrics "/api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics": get: tags: - Monitoring and Logs summary: Return All Atlas Search Metric Types for One Process description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. operationId: listMetricTypes parameters: - "$ref": "#/components/parameters/processId" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CloudSearchMetrics" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/listMetricTypes "/api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements": get: tags: - Monitoring and Logs summary: Return All Atlas Search Index Metrics for One Namespace description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. operationId: listIndexMetrics parameters: - "$ref": "#/components/parameters/processId" - "$ref": "#/components/parameters/databaseName" - "$ref": "#/components/parameters/collectionName" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/granularity" - "$ref": "#/components/parameters/period" - "$ref": "#/components/parameters/start" - "$ref": "#/components/parameters/end" - "$ref": "#/components/parameters/envelope" - name: metrics in: query description: List that contains the measurements that MongoDB Atlas reports for the associated data series. required: true style: form schema: maxItems: 10 uniqueItems: true type: array description: List that contains the measurements that MongoDB Atlas reports for the associated data series. items: type: string enum: - INDEX_SIZE_ON_DISK - NUMBER_OF_DELETES - NUMBER_OF_ERROR_QUERIES - NUMBER_OF_GETMORE_COMMANDS - NUMBER_OF_INDEX_FIELDS - NUMBER_OF_INSERTS - NUMBER_OF_SUCCESS_QUERIES - NUMBER_OF_UPDATES - REPLICATION_LAG - TOTAL_NUMBER_OF_QUERIES responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MeasurementsIndexes" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/listIndexMetrics "/api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics/measurements": get: tags: - Monitoring and Logs summary: Return Atlas Search Hardware and Status Metrics description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. operationId: getMeasurements parameters: - "$ref": "#/components/parameters/processId" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/granularity" - "$ref": "#/components/parameters/period" - "$ref": "#/components/parameters/start" - "$ref": "#/components/parameters/end" - "$ref": "#/components/parameters/envelope" - name: metrics in: query 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. required: true style: form schema: maxItems: 10 uniqueItems: true type: array description: List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series. items: type: string enum: - FTS_DISK_USAGE - FTS_PROCESS_CPU_KERNEL - FTS_PROCESS_CPU_USER - FTS_PROCESS_NORMALIZED_CPU_KERNEL - FTS_PROCESS_NORMALIZED_CPU_USER - FTS_PROCESS_RESIDENT_MEMORY - FTS_PROCESS_SHARED_MEMORY - FTS_PROCESS_VIRTUAL_MEMORY - JVM_CURRENT_MEMORY - JVM_MAX_MEMORY - PAGE_FAULTS responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MeasurementsNonIndex" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getMeasurements "/api/atlas/v1.0/groups/{groupId}/maintenanceWindow/defer": post: tags: - Maintenance Windows summary: Defer One Maintenance Window for One Project 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: deferMaintenanceWindow parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" responses: '200': description: OK '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Maintenance-Windows/operation/deferMaintenanceWindow "/api/atlas/v1.0/groups/{groupId}/maintenanceWindow": get: tags: - Maintenance Windows summary: Return One Maintenance Window for One Project 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: getMaintenanceWindow parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupMaintenanceWindow" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Maintenance-Windows/operation/getMaintenanceWindow delete: tags: - Maintenance Windows summary: Reset One Maintenance Window for One Project 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: resetMaintenanceWindow parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Maintenance-Windows/operation/resetMaintenanceWindow patch: tags: - Maintenance Windows summary: Update One Maintenance Window for One Project 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: updateMaintenanceWindow parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" requestBody: description: Updates the maintenance window for the specified project. content: application/json: schema: "$ref": "#/components/schemas/GroupMaintenanceWindow" required: true responses: '200': description: OK '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Maintenance-Windows/operation/updateMaintenanceWindow "/api/atlas/v1.0/groups/{groupId}/maintenanceWindow/autoDefer": post: tags: - Maintenance Windows summary: Toggle Automatic Deferral of Maintenance for One Project description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: toggleMaintenanceAutoDefer parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" responses: '200': description: OK '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer "/api/atlas/v1.0/groups": get: tags: - Projects summary: Return All Projects 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: listProjects parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAtlasGroupView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '400': "$ref": "#/components/responses/badRequest" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/listProjects post: tags: - Projects summary: Create One Project 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: createProject parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: projectOwnerId in: query 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. schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Creates one project. content: application/json: schema: "$ref": "#/components/schemas/Group" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Group" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/createProject "/api/atlas/v1.0/groups/{groupId}": get: tags: - Projects summary: Return One Project 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: getProject parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Group" '404': "$ref": "#/components/responses/notFound" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '400': "$ref": "#/components/responses/badRequest" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/getProject delete: tags: - Projects summary: Remove One Project 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: deleteProject parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/deleteProject patch: tags: - Projects summary: Update One Project 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: updateProject parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Project to update. content: application/json: schema: "$ref": "#/components/schemas/GroupUpdate" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Group" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/updateProject "/api/atlas/v1.0/groups/{groupId}/limits/{limitName}": get: tags: - Projects summary: Return One Limit for One Project 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: getProjectLimit parameters: - name: limitName in: path 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 if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | required: true schema: type: string enum: - atlas.project.security.databaseAccess.users - atlas.project.deployment.clusters - atlas.project.deployment.serverlessMTMs - atlas.project.security.databaseAccess.customRoles - atlas.project.security.networkAccess.entries - atlas.project.security.networkAccess.crossRegionEntries - atlas.project.deployment.nodesPerPrivateLinkRegion - dataFederation.bytesProcessed.query - dataFederation.bytesProcessed.daily - dataFederation.bytesProcessed.weekly - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - atlas.project.deployment.salesSoldM0s - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataFederationLimit" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/getProjectLimit delete: tags: - Projects summary: Remove One Project Limit 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: deleteProjectLimit parameters: - name: limitName in: path 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 if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | required: true schema: type: string enum: - atlas.project.security.databaseAccess.users - atlas.project.deployment.clusters - atlas.project.deployment.serverlessMTMs - atlas.project.security.databaseAccess.customRoles - atlas.project.security.networkAccess.entries - atlas.project.security.networkAccess.crossRegionEntries - atlas.project.deployment.nodesPerPrivateLinkRegion - dataFederation.bytesProcessed.query - dataFederation.bytesProcessed.daily - dataFederation.bytesProcessed.weekly - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - atlas.project.deployment.salesSoldM0s - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/deleteProjectLimit patch: tags: - Projects summary: Set One Project Limit 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: setProjectLimit parameters: - name: limitName in: path 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 if the org is not sales-sold (If org is sales-sold, the limit is 100) | 25 | 90 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | required: true schema: type: string enum: - atlas.project.security.databaseAccess.users - atlas.project.deployment.clusters - atlas.project.deployment.serverlessMTMs - atlas.project.security.databaseAccess.customRoles - atlas.project.security.networkAccess.entries - atlas.project.security.networkAccess.crossRegionEntries - atlas.project.deployment.nodesPerPrivateLinkRegion - dataFederation.bytesProcessed.query - dataFederation.bytesProcessed.daily - dataFederation.bytesProcessed.weekly - dataFederation.bytesProcessed.monthly - atlas.project.deployment.privateServiceConnectionsPerRegionGroup - atlas.project.deployment.privateServiceConnectionsSubnetMask - atlas.project.deployment.salesSoldM0s - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Limit to update. content: application/json: schema: "$ref": "#/components/schemas/DataFederationLimit" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataFederationLimit" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/setProjectLimit "/api/atlas/v1.0/groups/{groupId}/limits": get: tags: - Projects summary: Return All Limits for One Project 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: listProjectLimits parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DataFederationLimit" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/listProjectLimits "/api/atlas/v1.0/groups/byName/{groupName}": get: tags: - Projects summary: Return One Project by Name 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: getProjectByName parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: groupName in: path description: Human-readable label that identifies this project. required: true schema: maxLength: 64 minLength: 1 type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Group" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '400': "$ref": "#/components/responses/badRequest" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/getProjectByName "/api/atlas/v1.0/groups/{groupId}/settings": get: tags: - Projects summary: Return Project Settings 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: getProjectSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupSettings" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/getProjectSettings patch: tags: - Projects summary: Update Project Settings 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: updateProjectSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Settings to update. content: application/json: schema: "$ref": "#/components/schemas/GroupSettings" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GroupSettings" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/updateProjectSettings "/api/atlas/v1.0/groups/{groupId}/users": get: tags: - Projects summary: Return All MongoDB Cloud Users in One Project description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. operationId: listProjectUsers parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: flattenTeams in: query 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.' schema: type: boolean default: false - name: includeOrgUsers in: query 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.' schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedAppUserView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/listProjectUsers "/api/atlas/v1.0/groups/{groupId}/users/{userId}": delete: tags: - Projects summary: Remove One MongoDB Cloud User from One Project description: Removes the specified user from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: removeProjectUser parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: userId in: path description: Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '403': "$ref": "#/components/responses/forbidden" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Projects/operation/removeProjectUser "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping": post: tags: - Global Clusters summary: Add Custom Zone Mappings to One Global Cluster description: Add one or more custom zone mappings to 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: addAllCustomZoneMappings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Custom zone mapping to add to the specified global cluster. content: application/json: schema: "$ref": "#/components/schemas/CustomZoneMappings" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/addAllCustomZoneMappings delete: tags: - Global Clusters summary: Remove All Custom Zone Mappings from One Global Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: deleteAllLegacyCustomZoneMappings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/deleteAllLegacyCustomZoneMappings "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces": post: tags: - Global Clusters summary: Create One Managed Namespace in One Global Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: createLegacyManagedNamespace parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Managed namespace to create within the specified global cluster. content: application/json: schema: "$ref": "#/components/schemas/ManagedNamespaces" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '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" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/createLegacyManagedNamespace delete: tags: - Global Clusters summary: Remove One Managed Namespace from One Global Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: deleteLegacyManagedNamespace parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: db in: query description: Human-readable label that identifies the database that contains the collection. schema: type: string - name: collection in: query description: Human-readable label that identifies the collection associated with the managed namespace. schema: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/deleteLegacyManagedNamespace "/api/atlas/v1.0/groups/{groupId}/clusters": get: tags: - Clusters summary: Return All Clusters in One Project 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 does not include multi-cloud clusters. To return multi-cloud clusters, use Get All Advanced Clusters. 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 using the [createCluster](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 listFlexClusters endpoint for Flex clusters instead. externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters operationId: listLegacyClusters 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" - name: includeDeletedWithRetainedBackups in: query description: Flag that indicates whether to return Clusters with retain backups. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedLegacyClusterView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/listLegacyClusters post: tags: - Clusters summary: Create One Cluster description: |- Creates one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. This resource does not create multi-cloud clusters. To create a multi-cloud cluster, use Create One Advanced Cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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. 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 createFlexCluster API for such configurations moving forward. externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster operationId: createLegacyCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Cluster to create in this project. content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasCluster" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasCluster" '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" '500': "$ref": "#/components/responses/internalServerError" 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/v1/#tag/Clusters/operation/createLegacyCluster "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}": get: tags: - Clusters summary: Return One Cluster in One Project 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 does not include multi-cloud clusters. To return a multi-cloud cluster, use Get One Advanced Cluster. 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 using the [createCluster](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 getFlexCluster endpoint for Flex clusters instead. externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster operationId: getLegacyCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasCluster" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/getLegacyCluster delete: tags: - Clusters summary: Remove One Cluster description: |- Removes one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. 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 endpoint can also be used on Flex clusters that were created using the [createCluster](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 deleteFlexCluster endpoint for Flex clusters instead. externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster operationId: deleteLegacyCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: retainBackups in: query description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. schema: type: boolean responses: '202': description: Accepted '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/deleteLegacyCluster patch: tags: - Clusters summary: Update Configuration of One Cluster description: |- Update the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource does not update multi-cloud clusters. To update a multi-cloud cluster, use Update One Advanced Cluster. You can upgrade your cluster only one major version at a time. You can't skip any major versions. Each major version contains some features that might not be backward-compatible with previous versions. Check the Release Notes for changes that might affect your applications. After you upgrade the MongoDB major version, you will not be able to downgrade to previous versions. As of MongoDB version 4.2, Legacy Backups are deprecated in favor of Cloud Backups. When you upgrade to version 4.2 or later, your backup system upgrades to Cloud Backups if it is currently set to Legacy Backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). 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, and Flex clusters. The total number of nodes in clusters spanning across regions has a specific constraint on a per-project basis. MongoDB Cloud limits the total number of nodes in other regions in one project to a total of 40. This total excludes Google Cloud regions communicating with each other, free clusters, or shared clusters. The total number of nodes between any two regions must meet this constraint. For example, if a project has nodes in clusters spread across three regions: 30 nodes in Region A, 10 nodes in Region B, and 5 nodes in Region C, you can add only 5 more nodes to Region C because if you exclude Region C, Region A + Region B = 40. If you exclude Region B, Region A + Region C = 35, <= 40. If you exclude Region A, Region B + Region C = 15, <= 40. Each combination of regions with the added 5 nodes still meets the per-project constraint: Region A + B = 40, Region A + C = 40, and Region B + C = 20. You can't create a multi-region cluster in a project if it has one or more clusters spanning 40 or more nodes in other regions. operationId: updateClusterConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Cluster to update in the specified project. content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasCluster" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasCluster" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" 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/v1/#tag/Clusters/operation/updateClusterConfiguration "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites": get: tags: - Global Clusters summary: Return All Global Clusters Data description: Returns all managed namespaces and custom zone mappings for the specified global cluster. Managed namespaces identify collections using the database name, the dot separator, and the collection name. Custom zone mappings matches ISO 3166-2 location codes to zones in your global cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: getGeoSharding parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies this cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/GeoSharding" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Global-Clusters/operation/getGeoSharding "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs": get: tags: - Clusters summary: Return Advanced Configuration Options for One Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: getClusterAdvancedConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterDescriptionProcessArgs" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '404': "$ref": "#/components/responses/notFound" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/getClusterAdvancedConfiguration patch: tags: - Clusters summary: Update Advanced Configuration Options for One Cluster 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. externalDocs: description: Global Clusters url: https://www.mongodb.com/docs/atlas/global-clusters/ operationId: updateClusterAdvancedConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Advanced configuration details to add for one cluster in the specified project. content: application/json: schema: "$ref": "#/components/schemas/ClusterDescriptionProcessArgs" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ClusterDescriptionProcessArgs" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/updateClusterAdvancedConfiguration "/api/atlas/v1.0/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz": get: tags: - Monitoring and Logs summary: Download Logs for One Cluster Host in One Project 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 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".' operationId: downloadHostLogs parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: endDate in: query 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. schema: minimum: 1199145600 type: integer format: int64 - name: hostName in: path description: Human-readable label that identifies the host that stores the log files that you want to download. 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 - name: logName in: path 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. required: true schema: type: string externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ enum: - mongodb - mongos - mongodb-audit-log - mongos-audit-log - name: startDate in: query 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. schema: minimum: 1199145600 type: integer format: int64 responses: '200': description: OK content: application/gzip: schema: type: string description: Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project format: binary '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/downloadHostLogs "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restartPrimaries": post: tags: - Clusters summary: Test Failover for One Cluster 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. operationId: testLegacyFailover parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/testLegacyFailover "/api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade": post: tags: - Clusters summary: Upgrade One Shared-Tier Cluster 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 [createCluster](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 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead." externalDocs: description: upgradeFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster operationId: upgradeSharedCluster parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Details of the shared-tier cluster upgrade in the specified project. content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LegacyAtlasCluster" '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" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/upgradeSharedCluster "/api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgradeToServerless": post: tags: - Clusters summary: Upgrade One Shared-Tier Cluster to One Serverless Instance description: |- This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the upgradeFlexCluster 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: upgradeFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster operationId: upgradeSharedClusterToServerless parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Details of the shared-tier cluster upgrade in the specified project. content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescription" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescription" x-sunset: '2025-02-05' '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" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-changelog: '2025-02-06': Deprecating Tenant Upgrade to Serverless due to Flex GA. Atlas no longer supports the creation of new serverless instances. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/upgradeSharedClusterToServerless "/api/atlas/v1.0/groups/{groupId}/serverless": get: tags: - Serverless Instances summary: Return All Serverless Instances in One Project 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 [createServerlessInstance](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 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead. externalDocs: description: listFlexClusters url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters operationId: listServerlessInstances parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedServerlessInstanceDescriptionView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Instances/operation/listServerlessInstances post: tags: - Serverless Instances summary: Create One Serverless Instance in One Project description: |- Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. Creates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. externalDocs: description: createFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster operationId: createServerlessInstance parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Create One Serverless Instance in One Project. content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescriptionCreate" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescription" '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" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Instances/operation/createServerlessInstance "/api/atlas/v1.0/groups/{groupId}/serverless/{name}": get: tags: - Serverless Instances summary: Return One Serverless Instance from One Project 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 [createServerlessInstance](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 in January 2026. Please use the getFlexCluster endpoint instead. externalDocs: description: getFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster operationId: getServerlessInstance parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: name in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescription" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Instances/operation/getServerlessInstance delete: tags: - Serverless Instances summary: Remove One Serverless Instance from One Project description: |- Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting 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 [createServerlessInstance](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 in January 2026. Please use the deleteFlexCluster endpoint instead. externalDocs: description: deleteFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster operationId: deleteServerlessInstance parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: name in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/RequestAccepted" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Instances/operation/deleteServerlessInstance patch: tags: - Serverless Instances summary: Update One Serverless Instance in One Project description: |- Updates one serverless instance in 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 [createServerlessInstance](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 in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead. externalDocs: description: updateFlexCluster url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster operationId: updateServerlessInstance parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: name in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Update One Serverless Instance in One Project. content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescriptionUpdate" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessInstanceDescription" '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" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Instances/operation/updateServerlessInstance "/api/atlas/v1.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName}": get: tags: - Access Tracking summary: Return Database Access History for One Cluster by Cluster Name 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 or the Project Database Access Admin role. externalDocs: description: Database Access History url: https://docs.atlas.mongodb.com/access-tracking/ operationId: listAccessLogsByClusterName parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: authResult in: query description: Flag that indicates whether the response returns the successful authentication attempts only. schema: type: boolean - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: end in: query 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. schema: type: integer format: int64 - name: ipAddress in: query description: One Internet Protocol address that attempted to authenticate with the database. 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 - name: nLogs in: query description: Maximum number of lines from the log to return. schema: maximum: 20000 minimum: 0 type: integer format: int32 default: 20000 - name: start in: query 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. schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MongoDBAccessLogsList" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Access-Tracking/operation/listAccessLogsByClusterName "/api/atlas/v1.0/groups/{groupId}/dbAccessHistory/processes/{hostname}": get: tags: - Access Tracking summary: Return Database Access History for One Cluster by Hostname 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 or the Project Database Access Admin role. externalDocs: description: Database Access History url: https://docs.atlas.mongodb.com/access-tracking/ operationId: listAccessLogsByHostname parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: authResult in: query description: Flag that indicates whether the response returns the successful authentication attempts only. schema: type: boolean - name: end in: query 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. schema: type: integer format: int64 - name: hostname in: path description: Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. required: true schema: type: string - name: ipAddress in: query description: One Internet Protocol address that attempted to authenticate with the database. 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 - name: nLogs in: query description: Maximum number of lines from the log to return. schema: maximum: 20000 minimum: 0 type: integer format: int32 default: 20000 - name: start in: query 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. schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MongoDBAccessLogsList" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Access-Tracking/operation/listAccessLogsByHostname "/api/atlas/v1.0/groups/{groupId}/accessList": get: tags: - Project IP Access List summary: Return All Project IP Access List Entries 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: listProjectIpAccessLists parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedNetworkAccessView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" 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/v1/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists post: tags: - Project IP Access List summary: Add Entries to Project IP Access List 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 or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list operationId: createProjectIpAccessList parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" requestBody: description: One or more access list entries to add to the specified project. content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/NetworkPermissionEntry" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedNetworkAccessView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Project-IP-Access-List/operation/createProjectIpAccessList "/api/atlas/v1.0/groups/{groupId}/accessList/{entryValue}": get: tags: - Project IP Access List summary: Return One Project IP Access List Entry 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. TheProgrammatic API Keys endpoint (`/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist`) manages those access lists. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list operationId: getProjectIpList parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: entryValue in: path 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`).' required: true schema: 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 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' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/NetworkPermissionEntry" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Project-IP-Access-List/operation/getProjectIpList delete: tags: - Project IP Access List summary: Remove One Entry from One Project IP Access List 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. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list operationId: deleteProjectIpAccessList parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: entryValue in: path 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. required: true schema: 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 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' responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList "/api/atlas/v1.0/groups/{groupId}/accessList/{entryValue}/status": get: tags: - Project IP Access List summary: Return Status of One Project IP Access List Entry description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. operationId: getProjectIpAccessListStatus parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: entryValue in: path description: Network address or cloud provider security construct that identifies which project access list entry to be verified. required: true schema: 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 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' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/NetworkPermissionEntryStatus" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '400': "$ref": "#/components/responses/badRequest" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives": get: tags: - Online Archive summary: Return All Online Archives for One Cluster 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: listOnlineArchives parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedOnlineArchiveView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Online-Archive/operation/listOnlineArchives post: tags: - Online Archive summary: Create One Online Archive 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: createOnlineArchive parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Creates one online archive. content: application/json: schema: "$ref": "#/components/schemas/BackupOnlineArchiveCreate" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupOnlineArchive" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Online-Archive/operation/createOnlineArchive "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}": get: tags: - Online Archive summary: Return One Online Archive 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: getOnlineArchive parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: archiveId in: path description: Unique 24-hexadecimal digit string that identifies the online archive to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupOnlineArchive" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Online-Archive/operation/getOnlineArchive delete: tags: - Online Archive summary: Remove One Online Archive 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: deleteOnlineArchive parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - name: archiveId in: path description: Unique 24-hexadecimal digit string that identifies the online archive to delete. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Online-Archive/operation/deleteOnlineArchive patch: tags: - Online Archive summary: Update One Online Archive 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: updateOnlineArchive parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: archiveId in: path description: Unique 24-hexadecimal digit string that identifies the online archive to update. required: true schema: pattern: "^([a-f0-9]{24})$" type: string - name: clusterName in: path description: Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Updates, pauses, or resumes one online archive. content: application/json: schema: "$ref": "#/components/schemas/BackupOnlineArchive" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupOnlineArchive" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Online-Archive/operation/updateOnlineArchive "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz": get: tags: - Online Archive summary: Download Online Archive Query Logs 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/gzip".' externalDocs: description: Online Archive url: https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive operationId: downloadOnlineArchiveQueryLogs parameters: - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/envelope" - name: startDate in: query 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). schema: minimum: 1199145600 type: integer format: int64 example: 1636481348 - name: endDate in: query 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). schema: minimum: 1199145600 type: integer format: int64 example: 1636481348 - name: clusterName in: path 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. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: archiveOnly in: query description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. schema: type: boolean default: false responses: '200': description: OK content: application/gzip: schema: type: string 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 '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs "/api/atlas/v1.0/groups/{groupId}/peers": get: tags: - Network Peering summary: Return All Network Peering Connections in One Project 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: listPeeringConnections parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: providerName in: query description: Cloud service provider to use for this VPC peering connection. schema: type: string default: AWS enum: - AWS - AZURE - GCP responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedContainerPeerView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/listPeeringConnections post: tags: - Network Peering summary: Create One Network Peering Connection 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. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: description: Azure Network Peering Prerequisites url: https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites operationId: createPeeringConnection parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Create one network peering connection. content: application/json: schema: "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/createPeeringConnection "/api/atlas/v1.0/groups/{groupId}/peers/{peerId}": get: tags: - Network Peering summary: Return One Network Peering Connection in One Project 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: getPeeringConnection parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: peerId in: path description: Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/getPeeringConnection delete: tags: - Network Peering summary: Remove One Network Peering Connection description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: deletePeeringConnection parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: peerId in: path description: Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/RequestAccepted" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/deletePeeringConnection patch: tags: - Network Peering summary: Update One Network Peering Connection 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. operationId: updatePeeringConnection parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: peerId in: path description: Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Modify one network peering connection. content: application/json: schema: "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/updatePeeringConnection "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces": get: tags: - Performance Advisor summary: Return All Namespaces for One Host 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: listSlowQueryNamespaces parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: duration in: query 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. schema: type: integer format: int64 - name: processId in: path 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. 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 - name: since in: query 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. schema: minimum: 1199145600000 type: integer format: int64 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Namespaces" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Performance-Advisor/operation/listSlowQueryNamespaces "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs": get: tags: - Performance Advisor summary: Return Slow Queries 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: listSlowQueries parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: duration in: query 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. schema: type: integer format: int64 - name: namespaces in: query description: 'Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. 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.' style: form schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string - name: nLogs in: query description: Maximum number of lines from the log to return. schema: maximum: 20000 minimum: 0 type: integer format: int64 default: 20000 - name: processId in: path 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. 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 - name: since in: query 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. schema: minimum: 1199145600000 type: integer format: int64 - name: includeMetrics in: query description: Whether or not to include metrics extracted from the slow query log as separate fields. schema: type: boolean default: false - name: includeReplicaState in: query description: Whether or not to include the replica state of the host when the slow query log was generated as a separate field. schema: type: boolean default: false - name: includeOpType in: query description: Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PerformanceAdvisorSlowQueryList" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Performance-Advisor/operation/listSlowQueries "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes": get: tags: - Performance Advisor summary: Return All Suggested Indexes 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: listSuggestedIndexes parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: duration in: query 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. schema: type: integer format: int64 - name: namespaces in: query description: 'Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. 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.' style: form schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string - name: nExamples in: query description: Maximum number of example queries that benefit from the suggested index. schema: type: integer format: int64 default: 5 - name: nIndexes in: query description: Number that indicates the maximum indexes to suggest. schema: type: integer format: int64 - name: processId in: path 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. 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 - name: since in: query 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. schema: minimum: 1199145600000 type: integer format: int64 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PerformanceAdvisorResponse" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Performance-Advisor/operation/listSuggestedIndexes "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/endpointService": post: tags: - Private Endpoint Services summary: Create One Private Endpoint Service for One Provider 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: createPrivateEndpointService parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Creates one private endpoint for the specified cloud service provider. content: application/json: schema: "$ref": "#/components/schemas/CloudProviderEndpointServiceRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/EndpointService" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint": post: tags: - Private Endpoint Services summary: Create One Private Endpoint for One Provider 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: createPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Cloud service provider that manages this private endpoint. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP - name: endpointServiceId in: path description: Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Creates one private endpoint for the specified cloud service provider. content: application/json: schema: "$ref": "#/components/schemas/CreateEndpointRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PrivateLinkEndpoint" '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" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}": get: tags: - Private Endpoint Services summary: Return One Private Endpoint for One Provider 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: getPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Cloud service provider that manages this private endpoint. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP - name: endpointId in: path 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. 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 - name: endpointServiceId in: path description: Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PrivateLinkEndpoint" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint delete: tags: - Private Endpoint Services summary: Remove One Private Endpoint for One Provider 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: deletePrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Cloud service provider that manages this private endpoint. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP - name: endpointId in: path 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. 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 - name: endpointServiceId in: path description: Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}": get: tags: - Private Endpoint Services summary: Return One Private Endpoint Service for One Provider 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: getPrivateEndpointService parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Cloud service provider that manages this private endpoint service. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP - name: endpointServiceId in: path description: Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/EndpointService" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService delete: tags: - Private Endpoint Services summary: Remove One Private Endpoint Service for One Provider 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: deletePrivateEndpointService parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Cloud service provider that manages this private endpoint service. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP - name: endpointServiceId in: path description: Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService": get: tags: - Private Endpoint Services summary: Return All Private Endpoint Services for One Provider 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: listPrivateEndpointServices parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: cloudProvider in: path description: Cloud service provider that manages this private endpoint service. required: true schema: type: string default: AWS enum: - AWS - AZURE - GCP responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/EndpointService" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/regionalMode": get: tags: - Private Endpoint Services summary: Return Regionalized Private Endpoint Status 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: getRegionalizedPrivateEndpointSetting parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ProjectSettingItemView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting patch: tags: - Private Endpoint Services summary: Toggle Regionalized Private Endpoint Status 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: toggleRegionalizedPrivateEndpointSetting parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. content: application/json: schema: "$ref": "#/components/schemas/ProjectSettingItemView" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ProjectSettingItemView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting "/api/atlas/v1.0/groups/{groupId}/privateIpMode": get: tags: - Network Peering summary: Verify Connect via Peering-Only Mode for One Project 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: verifyConnectViaPeeringOnlyModeForOneProject parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PrivateIPModeView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject patch: tags: - Network Peering summary: Disable Connect via Peering-Only Mode for One Project 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: disablePeering parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Disables Connect via Peering Only mode for the specified project. content: application/json: schema: "$ref": "#/components/schemas/PrivateIPModeView" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PrivateIPModeView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Network-Peering/operation/disablePeering "/api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds": get: tags: - Data Federation summary: Return All Federated Database Instance and Online Archive Private Endpoints in One Project 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: listDataFederationPrivateEndpoints parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints post: tags: - Data Federation summary: Create One Federated Database Instance and Online Archive Private Endpoint for One Project description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`. `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`. `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`. `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`. `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`. `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`. `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`. `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. operationId: createDataFederationPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Private endpoint for Federated Database Instances and Online Archives to add to the specified project. content: application/json: schema: "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry" required: true responses: '201': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint "/api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}": get: tags: - Data Federation summary: Return One Federated Database Instance and Online Archive Private Endpoint in One Project 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: getDataFederationPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: endpointId in: path 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. required: true schema: pattern: "^vpce-[0-9a-f]{17}$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry" '404': "$ref": "#/components/responses/notFound" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint delete: tags: - Data Federation summary: Remove One Federated Database Instance and Online Archive Private Endpoint from One Project 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: deleteDataFederationPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: endpointId in: path 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. required: true schema: pattern: "^vpce-[0-9a-f]{17}$" type: string responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/databases": get: tags: - Monitoring and Logs summary: Return Available Databases for One MongoDB Process 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: listDatabases parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: processId in: path 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. 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 example: mongodb.example.com:27017 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedDatabaseView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/listDatabases "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/disks": get: tags: - Monitoring and Logs summary: Return Available Disks for One MongoDB Process 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: listDiskPartitions parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: processId in: path 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. 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 example: mongodb.example.com:27017 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedDiskPartitionView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/listDiskPartitions "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/measurements": get: tags: - Monitoring and Logs summary: Return Measurements for One MongoDB Process 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: getHostMeasurements parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: m in: query 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. style: form schema: maxItems: 10 minItems: 1 uniqueItems: true type: array items: type: string description: One measurement requested for this MongoDB process. enum: - ASSERT_MSG - ASSERT_REGULAR - ASSERT_USER - ASSERT_WARNING - BACKGROUND_FLUSH_AVG - CACHE_BYTES_READ_INTO - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES - 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 - "$ref": "#/components/parameters/period" - name: processId in: path 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. 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 example: mongodb.example.com:27017 - "$ref": "#/components/parameters/granularity" - "$ref": "#/components/parameters/start" - "$ref": "#/components/parameters/end" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiMeasurementsGeneralView_Atlas" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getHostMeasurements "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/databases/{databaseName}": get: tags: - Monitoring and Logs summary: Return One Database for One MongoDB Process 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: getDatabase parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: databaseName in: path description: Human-readable label that identifies the database that the specified MongoDB process serves. required: true schema: type: string - name: processId in: path 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. 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 example: mongodb.example.com:27017 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MesurementsDatabase" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getDatabase "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements": get: tags: - Monitoring and Logs summary: Return Measurements for One Database in One MongoDB Process 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: getDatabaseMeasurements parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: databaseName in: path description: Human-readable label that identifies the database that the specified MongoDB process serves. required: true schema: type: string - name: m in: query 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. style: form schema: maxItems: 10 minItems: 1 uniqueItems: true type: array items: type: string description: One measurement requested for this MongoDB process. enum: - DATABASE_AVERAGE_OBJECT_SIZE - DATABASE_COLLECTION_COUNT - DATABASE_DATA_SIZE - DATABASE_STORAGE_SIZE - DATABASE_INDEX_SIZE - DATABASE_INDEX_COUNT - DATABASE_EXTENT_COUNT - DATABASE_OBJECT_COUNT - DATABASE_VIEW_COUNT - name: processId in: path 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. 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 example: mongodb.example.com:27017 - "$ref": "#/components/parameters/granularity" - "$ref": "#/components/parameters/period" - "$ref": "#/components/parameters/start" - "$ref": "#/components/parameters/end" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiMeasurementsGeneralView_Atlas" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/disks/{partitionName}": get: tags: - Monitoring and Logs summary: Return Measurements for One Disk 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: listDiskMeasurements parameters: - "$ref": "#/components/parameters/envelope" - name: partitionName in: path description: Human-readable label of the disk or partition to which the measurements apply. required: true schema: type: string - "$ref": "#/components/parameters/groupId" - name: processId in: path 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. 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 example: mongodb.example.com:27017 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/MeasurementDiskPartition" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/listDiskMeasurements "/api/atlas/v1.0/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements": get: tags: - Monitoring and Logs summary: Return Measurements of One Disk for One MongoDB Process 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: getDiskMeasurements parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: m in: query 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. style: form schema: maxItems: 10 minItems: 1 uniqueItems: true type: array items: type: string description: One measurement requested for this MongoDB process. enum: - DISK_PARTITION_IOPS_READ - MAX_DISK_PARTITION_IOPS_READ - DISK_PARTITION_IOPS_WRITE - MAX_DISK_PARTITION_IOPS_WRITE - DISK_PARTITION_IOPS_TOTAL - MAX_DISK_PARTITION_IOPS_TOTAL - DISK_PARTITION_LATENCY_READ - MAX_DISK_PARTITION_LATENCY_READ - DISK_PARTITION_LATENCY_WRITE - MAX_DISK_PARTITION_LATENCY_WRITE - DISK_PARTITION_SPACE_FREE - MAX_DISK_PARTITION_SPACE_FREE - DISK_PARTITION_SPACE_USED - MAX_DISK_PARTITION_SPACE_USED - DISK_PARTITION_SPACE_PERCENT_FREE - MAX_DISK_PARTITION_SPACE_PERCENT_FREE - DISK_PARTITION_SPACE_PERCENT_USED - MAX_DISK_PARTITION_SPACE_PERCENT_USED - DISK_PARTITION_THROUGHPUT_READ - DISK_PARTITION_THROUGHPUT_WRITE - DISK_QUEUE_DEPTH - name: partitionName in: path description: Human-readable label of the disk or partition to which the measurements apply. required: true schema: type: string - name: processId in: path 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. 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 example: mongodb.example.com:27017 - "$ref": "#/components/parameters/period" - "$ref": "#/components/parameters/granularity" - "$ref": "#/components/parameters/start" - "$ref": "#/components/parameters/end" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiMeasurementsGeneralView_Atlas" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getDiskMeasurements "/api/atlas/v1.0/groups/{groupId}/processes": get: tags: - Monitoring and Logs summary: Return All MongoDB Processes in One Project 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: listAtlasProcesses parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedHostView_Atlas" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/listAtlasProcesses "/api/atlas/v1.0/groups/{groupId}/processes/{processId}": get: tags: - Monitoring and Logs summary: Return One MongoDB Process by ID 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: getAtlasProcess parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: processId in: path 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. 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 example: mongodb.example.com:27017 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiHostView_Atlas" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Monitoring-and-Logs/operation/getAtlasProcess "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs": get: tags: - Legacy Backup summary: Return All Legacy Backup Restore Jobs 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: listLegacyBackupRestoreJobs parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: batchId in: query 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. schema: pattern: "^([a-f0-9]{24})$" type: string - name: clusterName in: path description: Human-readable label that identifies the cluster with the snapshot you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedRestoreJobView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs post: tags: - Legacy Backup summary: Create One Legacy Backup Restore Job 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: createLegacyBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster with the snapshot you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Legacy backup to restore to one cluster in the specified project. content: application/json: schema: "$ref": "#/components/schemas/BackupRestoreJob" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedRestoreJobView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}": get: tags: - Legacy Backup summary: Return One Legacy Backup Restore Job 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: getLegacyBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster with the snapshot you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: jobId in: path description: Unique 24-hexadecimal digit string that identifies the restore job. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupRestoreJob" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}": get: tags: - Clusters summary: Return Status of Sample Dataset Load for One Cluster 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: getSampleDatasetLoadStatus parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: sampleDatasetId in: path description: Unique 24-hexadecimal digit string that identifies the loaded sample dataset. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/SampleDatasetStatus" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/getSampleDatasetLoadStatus "/api/atlas/v1.0/groups/{groupId}/sampleDatasetLoad/{name}": post: tags: - Clusters summary: Load Sample Dataset into One Cluster 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: loadSampleDataset parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: name in: path description: Human-readable label that identifies the cluster into which you load the sample dataset. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/SampleDatasetStatus" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Clusters/operation/loadSampleDataset "/api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs": get: tags: - Cloud Backups summary: Return All Restore Jobs for One Serverless Instance 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 [createServerlessInstance](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 in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs operationId: listServerlessBackupRestoreJobs parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs post: tags: - Cloud Backups summary: Restore One Snapshot of One Serverless Instance 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 [createServerlessInstance](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 in January 2026. Please use the createFlexBackupRestoreJob endpoint instead. externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob operationId: createServerlessBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the serverless instance whose snapshot you want to restore. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Restores one snapshot of one serverless instance from the specified project. content: application/json: schema: "$ref": "#/components/schemas/ServerlessBackupRestoreJob" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessBackupRestoreJob" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}": get: tags: - Cloud Backups summary: Return One Restore Job for One Serverless Instance 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 [createServerlessInstance](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 in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob operationId: getServerlessBackupRestoreJob parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: restoreJobId in: path description: Unique 24-hexadecimal digit string that identifies the restore job to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessBackupRestoreJob" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}": get: tags: - Cloud Backups summary: Return One Snapshot of One Serverless Instance 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 [createServerlessInstance](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 in January 2026. Please use the getFlexBackup endpoint instead. externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup operationId: getServerlessBackup parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessBackupSnapshot" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getServerlessBackup "/api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/snapshots": get: tags: - Cloud Backups summary: Return All Snapshots of One Serverless Instance 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 [createServerlessInstance](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 in January 2026. Please use the listFlexBackups endpoint instead. externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups operationId: listServerlessBackups parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - name: clusterName in: path description: Human-readable label that identifies the serverless instance. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listServerlessBackups "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint": get: tags: - Serverless Private Endpoints summary: Return All Private Endpoints for One Serverless Instance 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. operationId: listServerlessPrivateEndpoints parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: instanceName in: path description: Human-readable label that identifies the serverless instance associated with the tenant endpoint. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: type: array x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ServerlessTenantEndpoint" x-xgen-IPA-exception: xgen-IPA-110-collections-response-define-results-array: Content predates IPA validation xgen-IPA-110-collections-use-paginated-prefix: Content predates IPA validation '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '400': "$ref": "#/components/responses/badRequest" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints post: tags: - Serverless Private Endpoints summary: Create One Private Endpoint for One Serverless Instance 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. externalDocs: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint operationId: createServerlessPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: instanceName in: path description: Human-readable label that identifies the serverless instance for which the tenant endpoint will be created. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Information about the Private Endpoint to create for the Serverless Instance. content: application/json: schema: "$ref": "#/components/schemas/ServerlessTenantCreateRequest" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/ServerlessTenantEndpoint" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '400': "$ref": "#/components/responses/badRequest" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint "/api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}": get: tags: - Serverless Private Endpoints summary: Return One Private Endpoint for One Serverless Instance 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. operationId: getServerlessPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: instanceName in: path description: Human-readable label that identifies the serverless instance associated with the tenant endpoint. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: endpointId in: path description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessTenantEndpoint" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint delete: tags: - Serverless Private Endpoints summary: Remove One Private Endpoint for One Serverless Instance 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. operationId: deleteServerlessPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: instanceName in: path description: Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: endpointId in: path description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint patch: tags: - Serverless Private Endpoints summary: Update One Private Endpoint for One Serverless Instance 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. operationId: updateServerlessPrivateEndpoint parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: instanceName in: path description: Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: endpointId in: path description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Object used for update. content: application/json: schema: "$ref": "#/components/schemas/ServerlessTenantEndpointUpdate" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ServerlessTenantEndpoint" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshotSchedule": get: tags: - Legacy Backup summary: Return One Snapshot Schedule 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: getLegacySnapshotSchedule parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster with the snapshot you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule patch: tags: - Legacy Backup summary: Update Snapshot Schedule for One Cluster 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: updateLegacySnapshotSchedule parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/groupId" - name: clusterName in: path description: Human-readable label that identifies the cluster with the snapshot you want to return. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string requestBody: description: Update the snapshot schedule for one cluster in the specified project. content: application/json: schema: "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}": get: tags: - Legacy Backup summary: Return One Legacy Backup Snapshot 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: getLegacySnapshot parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupSnapshot" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/getLegacySnapshot delete: tags: - Legacy Backup summary: Remove One Legacy Backup Snapshot 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: deleteLegacySnapshot parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '204': description: This endpoint does not return a response body. content: application/json: {} '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/deleteLegacySnapshot patch: tags: - Legacy Backup summary: Update Expiration Date for One Legacy Backup Snapshot 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: updateLegacySnapshotRetention parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string requestBody: description: Changes One Legacy Backup Snapshot Expiration. content: application/json: schema: "$ref": "#/components/schemas/BackupSnapshot" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupSnapshot" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshots": get: tags: - Legacy Backup summary: Return All Legacy Backup Snapshots 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: listLegacySnapshots parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/includeCount" - "$ref": "#/components/parameters/itemsPerPage" - "$ref": "#/components/parameters/pageNum" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: completed in: query description: Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots. schema: type: string default: 'true' enum: - all - 'true' - 'false' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedSnapshotView" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Legacy-Backup/operation/listLegacySnapshots "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore": post: tags: - Shared-Tier Restore Jobs summary: Create One Restore Job for One M2 or M5 Cluster description: |- Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This endpoint can also be used on Flex clusters that were created using the [createCluster](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, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. externalDocs: description: createFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob operationId: createSharedClusterBackupRestoreJob parameters: - name: clusterName in: path description: Human-readable label that identifies the cluster. 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: description: The restore job details. content: application/json: schema: "$ref": "#/components/schemas/TenantRestore" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TenantRestore" x-xgen-version: '2025-05-20' x-sunset: '2026-01-15' '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/download": post: tags: - Shared-Tier Snapshots summary: Download One M2 or M5 Cluster Snapshot description: |- Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This endpoint can also be used on Flex clusters that were created using the [createCluster](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, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. externalDocs: description: downloadFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup operationId: downloadSharedClusterBackup parameters: - name: clusterName in: path description: Human-readable label that identifies the cluster. 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: description: Snapshot to be downloaded. content: application/json: schema: "$ref": "#/components/schemas/TenantRestore" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TenantRestore" x-xgen-version: '2025-05-20' x-sunset: '2026-01-15' '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}": get: tags: - Shared-Tier Restore Jobs summary: Return One Restore Job for One M2 or M5 Cluster description: |- Returns the specified restore job for the specified M2 or M5 cluster. 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 using the [createCluster](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, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. externalDocs: description: getFlexBackupRestoreJob url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob operationId: getSharedClusterBackupRestoreJob parameters: - name: clusterName in: path description: Human-readable label that identifies the cluster. 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" - name: restoreId in: path description: Unique 24-hexadecimal digit string that identifies the restore job to return. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/TenantRestore" x-xgen-version: '2025-05-20' x-sunset: '2026-01-15' '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores": get: tags: - Shared-Tier Restore Jobs summary: Return All Restore Jobs for One M2 or M5 Cluster description: |- Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created using the [createCluster](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, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. externalDocs: description: listFlexBackupRestoreJobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs operationId: listSharedClusterBackupRestoreJobs parameters: - name: clusterName in: path description: Human-readable label that identifies the cluster. 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" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedTenantRestoreView" x-xgen-version: '2025-05-20' x-sunset: '2026-01-15' '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}": get: tags: - Shared-Tier Snapshots summary: Return One Snapshot of One M2 or M5 Cluster description: |- Returns details for one snapshot for the specified shared cluster. 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 using the [createCluster](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, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. externalDocs: description: getFlexBackup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup operationId: getSharedClusterBackup parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string - name: snapshotId in: path description: Unique 24-hexadecimal digit string that identifies the desired snapshot. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/BackupTenantSnapshot" x-xgen-version: '2025-05-20' x-sunset: '2026-01-15' '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup "/api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots": get: tags: - Shared-Tier Snapshots summary: Return All Snapshots for One M2 or M5 Cluster description: |- Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This API also works for Flex clusters that were created using the [createCluster](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, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. externalDocs: description: listFlexBackups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups operationId: listSharedClusterBackups parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: clusterName in: path description: Human-readable label that identifies the cluster. required: true schema: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PaginatedTenantSnapshotView" x-xgen-version: '2025-05-20' x-sunset: '2026-01-15' '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" deprecated: true x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups "/api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/verify/{requestId}": get: tags: - LDAP Configuration summary: Return Status of LDAP Configuration Verification in One Project 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: getLdapConfigurationStatus parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" - name: requestId in: path description: Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration. required: true schema: pattern: "^([a-f0-9]{24})$" type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus "/api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/verify": post: tags: - LDAP Configuration summary: Verify LDAP Configuration in One Project 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: verifyLdapConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: The LDAP configuration for the specified project that you want to verify. content: application/json: schema: "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequest" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/LDAP-Configuration/operation/verifyLdapConfiguration "/api/atlas/v1.0/groups/{groupId}/userSecurity/ldap/userToDNMapping": delete: tags: - LDAP Configuration summary: Remove LDAP User to DN Mapping 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: deleteLdapConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/UserSecurity" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/LDAP-Configuration/operation/deleteLdapConfiguration "/api/atlas/v1.0/groups/{groupId}/userSecurity/customerX509": delete: tags: - X.509 Authentication summary: Disable Customer-Managed X.509 description: |- Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. operationId: disableCustomerManagedX509 parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/UserSecurity" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/X.509-Authentication/operation/disableCustomerManagedX509 "/api/atlas/v1.0/groups/{groupId}/userSecurity": get: tags: - LDAP Configuration summary: Return LDAP or X.509 Configuration 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: getLdapConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/UserSecurity" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/LDAP-Configuration/operation/getLdapConfiguration patch: tags: - LDAP Configuration summary: Update LDAP or X.509 Configuration 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: saveLdapConfiguration parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" requestBody: description: Updates the LDAP configuration for the specified project. content: application/json: schema: "$ref": "#/components/schemas/UserSecurity" required: true responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/UserSecurity" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/LDAP-Configuration/operation/saveLdapConfiguration "/api/atlas/v1.0/groups/{groupId}/backupCompliancePolicy": get: tags: - Cloud Backups summary: Return Backup Compliance Policy Settings 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. operationId: getDataProtectionSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataProtectionSettings" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getDataProtectionSettings put: tags: - Cloud Backups summary: Update Backup Compliance Policy Settings 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. operationId: updateDataProtectionSettings parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - name: overwriteBackupPolicies in: query description: Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not. schema: type: boolean default: true - "$ref": "#/components/parameters/pretty" requestBody: description: The new Backup Compliance Policy settings. content: application/json: schema: "$ref": "#/components/schemas/DataProtectionSettings" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/DataProtectionSettings" '400': "$ref": "#/components/responses/badRequest" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/updateDataProtectionSettings "/api/atlas/v1.0/groups/{groupId}/managedSlowMs/disable": delete: tags: - Performance Advisor summary: Disable Managed Slow Operation Threshold 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: disableSlowOperationThresholding parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Performance-Advisor/operation/disableSlowOperationThresholding "/api/atlas/v1.0/groups/{groupId}/managedSlowMs/enable": post: tags: - Performance Advisor summary: Enable Managed Slow Operation Threshold 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: enableSlowOperationThresholding parameters: - "$ref": "#/components/parameters/envelope" - "$ref": "#/components/parameters/groupId" - "$ref": "#/components/parameters/pretty" responses: '204': description: This endpoint does not return a response body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/notFound" '500': "$ref": "#/components/responses/internalServerError" '429': "$ref": "#/components/responses/tooManyRequests" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Performance-Advisor/operation/enableSlowOperationThresholding components: schemas: RequestAccepted: type: object description: Accepted ObjectCreated: type: object description: Created NoBody: type: object description: Endpoint does not return a response body. ApiAtlasFTSMappingsViewManual: title: mappings type: object properties: dynamic: type: boolean 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 default: false fields: type: object additionalProperties: type: object externalDocs: description: Atlas Search Field Mappings url: https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings description: One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**. externalDocs: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts description: Index specifications for the collection's fields. AlertAudit: title: Alert Audits required: - created - eventTypeName - id type: object properties: alertId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/AlertAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Alert audit indicates acknowledgement status of an alert. AlertAuditTypeView: title: Alert Audit Types type: string description: Unique identifier of event type. example: ALERT_ACKNOWLEDGED_AUDIT enum: - ALERT_ACKNOWLEDGED_AUDIT - ALERT_UNACKNOWLEDGED_AUDIT AlertConfigAudit: title: Alert Config Audits required: - created - eventTypeName - id type: object properties: alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**. readOnly: true example: 32b6e34b3d91647abb20e7b8 apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/AlertConfigAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Alert config audit indicates any activities around alert settings. AlertConfigAuditTypeView: title: Alert Audit Types type: string description: Unique identifier of event type. example: ALERT_CONFIG_ADDED_AUDIT enum: - ALERT_CONFIG_DISABLED_AUDIT - ALERT_CONFIG_ENABLED_AUDIT - ALERT_CONFIG_ADDED_AUDIT - ALERT_CONFIG_DELETED_AUDIT - ALERT_CONFIG_CHANGED_AUDIT ApiUserEventTypeViewForNdsGroup: title: API User Event Types type: string description: Unique identifier of event type. example: API_KEY_CREATED 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 ApiUserEventViewForNdsGroup: title: API User Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ApiUserEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 targetPublicKey: type: string description: Public part of the API key that this event targets. readOnly: true example: zmmrboas userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 whitelistEntry: type: string description: Entry in the list of source host addresses that the API key accepts and this event targets. readOnly: true example: 0.0.0.0 description: API User event identifies different activities around user api keys. AppServiceEventTypeView: title: App Services Event Types type: string description: Unique identifier of event type. example: DEPLOYMENT_FAILURE 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 AppServiceEventView: title: App Services Events required: - created - eventTypeName - id type: object properties: created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/AppServiceEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 raw: "$ref": "#/components/schemas/raw" description: App Services event identifies different activities about a BAAS application. AtlasResourcePolicyAuditForNdsGroup: title: Atlas Resource Policy Audits For NDS Group required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: title: Atlas Resource Policy Audit Types type: string description: Unique identifier of event type. example: RESOURCE_POLICY_VIOLATED enum: - RESOURCE_POLICY_VIOLATED groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 resourcePolicyId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the resource policy. readOnly: true example: 32b6e34b3d91647abb20e7b8 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 violatedPolicies: type: array description: String representation of the violated resource policy ids. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string violationAction: type: string description: Resource policy action taken by the user and evaluated against the currently active policies. readOnly: true description: Atlas resource policy audits indicate org level changes to resource policies AutomationConfigEventTypeView: title: Automation Config Event Types type: string description: Unique identifier of event type. example: AUTOMATION_CONFIG_PUBLISHED_AUDIT enum: - AUTOMATION_CONFIG_PUBLISHED_AUDIT AutomationConfigEventView: title: Automation Config Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/AutomationConfigEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Automation config event identifies that deployment configuration is published. BillingEventTypeViewForNdsGroup: title: Billing Event Types type: string description: Unique identifier of event type. example: CREDIT_CARD_CURRENT 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 BillingEventViewForNdsGroup: title: Billing Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/BillingEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 invoiceId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 paymentId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Billing event identifies different activities related to billing, payment or financial status change of an organization. ChartsAudit: required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ChartsAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Audit events related to Atlas Charts ChartsAuditTypeView: title: Charts Api Call Audit Types type: string description: Unique identifier of event type. example: CHARTS_API_SUCCESS enum: - CHARTS_API_SUCCESS - CHARTS_API_FAILURE ClusterEventTypeViewForNdsGroup: title: Cluster Event Types type: string description: Unique identifier of event type. example: CLUSTER_MONGOS_IS_PRESENT enum: - CLUSTER_MONGOS_IS_PRESENT - CLUSTER_MONGOS_IS_MISSING ClusterEventViewForNdsGroup: title: Cluster Events required: - created - eventTypeName - id type: object properties: created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 raw: "$ref": "#/components/schemas/raw" shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 description: Cluster event identifies different activities about cluster of mongod hosts. DataExplorerAccessedEventTypeView: title: Data Explorer Accessed Event Types type: string description: Unique identifier of event type. example: DATA_EXPLORER enum: - DATA_EXPLORER - DATA_EXPLORER_CRUD_ATTEMPT - DATA_EXPLORER_CRUD_ERROR - DATA_EXPLORER_CRUD DataExplorerAccessedEventView: title: Data Explorer Accessed Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key collection: type: string description: Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`. readOnly: true example: test_collection created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 database: type: string 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"`.' readOnly: true example: test_db eventTypeName: "$ref": "#/components/schemas/DataExplorerAccessedEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" opType: type: string description: 'Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName" : "DATA_EXPLORER"`.' readOnly: true example: insertDocument orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Data Explorer accessed event tracks different data operations via Data Explorer interactions. DataExplorerEvent: title: Data Explorer Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/DataExplorerEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 sessionId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the Data Explorer session associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Data Explorer event tracks different Data Explorer operations. DataExplorerEventTypeView: title: Data Explorer Event Types type: string description: Unique identifier of event type. example: DATA_EXPLORER_SESSION_CREATED enum: - DATA_EXPLORER_SESSION_CREATED DataMetricEventView: required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/DataMetricValueView" deskLocation: type: string description: Desk location of MongoDB employee associated with the event. readOnly: true employeeIdentifier: type: string description: Identifier of MongoDB employee associated with the event. readOnly: true eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. readOnly: true orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 DataMetricUnits: title: Data Metric Units type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. example: BYTES enum: - BITS - KILOBITS - MEGABITS - GIGABITS - BYTES - KILOBYTES - MEGABYTES - GIGABYTES - TERABYTES - PETABYTES DataMetricValueView: title: Data Metric Value type: object properties: number: type: number description: Amount of the **metricName** recorded at the time of the event. This value triggered the alert. format: double readOnly: true units: "$ref": "#/components/schemas/DataMetricUnits" description: Measurement of the **metricName** recorded at the time of the event. readOnly: true DefaultEventViewForNdsGroup: title: Any Other Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: type: object description: Unique identifier of event type. oneOf: - title: Auto Indexing 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: AWS Peer Vpc Audit Types type: string enum: - PEER_CREATED - PEER_DELETED - PEER_UPDATED - title: Azure Peer Network Audit Types type: string enum: - AZURE_PEER_CREATED - AZURE_PEER_UPDATED - AZURE_PEER_ACTIVE - AZURE_PEER_DELETED - title: Cluster Connection 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 - title: Cps Backup 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_AUTO_EXPORT_FAILED - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED - CPS_OPLOG_BEHIND - CPS_OPLOG_CAUGHT_UP - title: CPS Backup Compliance Policy 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: Disk Backup 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: Encryption 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: Export Bucket Audit Types type: string enum: - BUCKET_CREATED_AUDIT - BUCKET_DELETED_AUDIT - title: GCP Peer Vpc Audit Types type: string enum: - GCP_PEER_CREATED - GCP_PEER_DELETED - GCP_PEER_UPDATED - GCP_PEER_ACTIVE - GCP_PEER_INACTIVE - title: Group 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 - title: Group Event 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 - title: Group Integration Event Types type: string enum: - INTEGRATION_CONFIGURED - INTEGRATION_REMOVED - title: Index Build Audit Types type: string enum: - ROLLING_INDEX_FAILED_INDEX_BUILD - ROLLING_INDEX_SUCCESS_INDEX_BUILD - INDEX_FAILED_INDEX_BUILD - INDEX_SUCCESS_INDEX_BUILD - title: NDS DB Check Audit Types type: string enum: - DB_CHECK_SUBMITTED - 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: NDS Data Validation Audit Types type: string enum: - CLUSTER_SAMPLED_FOR_DATA_VALIDATION - DATA_VALIDATION_SUBMITTED_FOR_CLUSTER - CLUSTER_OPTED_OUT_OF_DATA_VALIDATION - title: NDS Maintenance Window Audit Types type: string enum: - MAINTENANCE_IN_ADVANCED - MAINTENANCE_AUTO_DEFERRED - MAINTENANCE_STARTED - MAINTENANCE_NO_LONGER_NEEDED - title: NDS Serverless Auto Scaling 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: NDS Tenant Endpoint Service Deployment 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: NDS x509 User Auth Event 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: Online Archive 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: Private Link Audit Types type: string enum: - ENDPOINT_SERVICE_CREATED - ENDPOINT_SERVICE_DELETED - INTERFACE_ENDPOINT_CREATED - INTERFACE_ENDPOINT_DELETED - INTERFACE_ENDPOINT_PATCHED - title: Proactive Operation Event Types type: string enum: - PROACTIVE_OPERATION_EVENT_LOGGED - title: Search Deployment Audit Types type: string enum: - SEARCH_DEPLOYMENT_CREATED - SEARCH_DEPLOYMENT_UPDATED - SEARCH_DEPLOYMENT_DELETED - title: Serverless 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 Event Types type: string enum: - INSIDE_SERVERLESS_METRIC_THRESHOLD - OUTSIDE_SERVERLESS_METRIC_THRESHOLD - title: Flex Metric Event Types type: string enum: - INSIDE_FLEX_METRIC_THRESHOLD - OUTSIDE_FLEX_METRIC_THRESHOLD - title: Setup Serverless Audit Types type: string enum: - SETUP_SERVERLESS_INITIATED - title: Streams Event Types type: string enum: - MAX_PROCESSOR_COUNT_REACHED - title: Stream Processor Event Types type: string enum: - STREAM_PROCESSOR_STATE_IS_FAILED - INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - title: Support Case Event Types type: string enum: - CASE_CREATED - title: Support Event Types type: string enum: - SUPPORT_EMAILS_SENT_SUCCESSFULLY - SUPPORT_EMAILS_SENT_FAILURE - title: Tenant Backup 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: Version Audit Types type: string enum: - CLUSTER_VERSION_FIXED - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - ACME_PROVIDER_FIXED - ACME_PROVIDER_UNFIXED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED - CLUSTER_BINARY_VERSION_DOWNGRADED - CLUSTER_BINARY_VERSION_UPGRADED - CLUSTER_OS_FIXED - CLUSTER_OS_UNFIXED - title: Access Event Types type: string enum: - EMPLOYEE_DOWNLOADED_CLUSTER_LOGS groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Other events which don't have extra details beside of basic one. EventViewForNdsGroup: type: object x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation 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" FTSIndexAuditTypeView: title: FTS Index Audit Types type: string description: Unique identifier of event type. example: FTS_INDEX_CREATED 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_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED - FTS_INDEXES_SYNONYM_MAPPING_INVALID FTSIndexAuditView: title: FTS Index Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/FTSIndexAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: FTS index audit indicates any activities about search index. ForNdsGroup: title: ReplicaSet Events required: - created - eventTypeName - id type: object properties: created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 raw: "$ref": "#/components/schemas/raw" replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 description: ReplicaSet Event identifies different activities about replica set of mongod instances. GroupPaginatedEventView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/EventViewForNdsGroup" totalCount: minimum: 0 type: integer 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 readOnly: true HostEventTypeViewForNdsGroup: title: Host Event Types type: string description: Unique identifier of event type. example: HOST_DOWN enum: - AUTO_CREATED_INDEX_AUDIT - 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_SUFFICIENT_DISK_SPACE - HOST_MONGOT_APPROACHING_STOP_REPLICATION - 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 - 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 HostEventViewForNdsGroup: title: Host Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 deskLocation: type: string description: Desk location of MongoDB employee associated with the event. readOnly: true employeeIdentifier: type: string description: Identifier of MongoDB employee associated with the event. readOnly: true eventTypeName: "$ref": "#/components/schemas/HostEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Host event identifies different activities about mongod host. HostMetricEvent: title: Host Metric Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/HostMetricValue" deskLocation: type: string description: Desk location of MongoDB employee associated with the event. readOnly: true employeeIdentifier: type: string description: Identifier of MongoDB employee associated with the event. readOnly: true eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. readOnly: true orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Host Metric Event reflects different measurements and metrics about mongod host. discriminator: propertyName: metricName mapping: ASSERT_REGULAR: "#/components/schemas/RawMetricEventView" ASSERT_WARNING: "#/components/schemas/RawMetricEventView" ASSERT_MSG: "#/components/schemas/RawMetricEventView" ASSERT_USER: "#/components/schemas/RawMetricEventView" OPCOUNTER_CMD: "#/components/schemas/RawMetricEventView" OPCOUNTER_QUERY: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_DELETE: "#/components/schemas/RawMetricEventView" OPCOUNTER_TTL_DELETED: "#/components/schemas/RawMetricEventView" OPCOUNTER_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_GETMORE: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_CMD: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_DELETE: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" FTS_MEMORY_RESIDENT: "#/components/schemas/DataMetricEventView" FTS_MEMORY_VIRTUAL: "#/components/schemas/DataMetricEventView" FTS_MEMORY_MAPPED: "#/components/schemas/DataMetricEventView" FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricEventView" FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricEventView" NORMALIZED_FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricEventView" NORMALIZED_FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricEventView" SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricEventView" MEMORY_RESIDENT: "#/components/schemas/DataMetricEventView" MEMORY_VIRTUAL: "#/components/schemas/DataMetricEventView" MEMORY_MAPPED: "#/components/schemas/DataMetricEventView" COMPUTED_MEMORY: "#/components/schemas/DataMetricEventView" 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" GLOBAL_LOCK_PERCENTAGE: "#/components/schemas/RawMetricEventView" BACKGROUND_FLUSH_AVG: "#/components/schemas/TimeMetricEventView" CONNECTIONS: "#/components/schemas/RawMetricEventView" CONNECTIONS_MAX: "#/components/schemas/RawMetricEventView" CONNECTIONS_PERCENT: "#/components/schemas/RawMetricEventView" GLOBAL_ACCESSES_NOT_IN_MEMORY: "#/components/schemas/RawMetricEventView" GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: "#/components/schemas/RawMetricEventView" GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: "#/components/schemas/RawMetricEventView" GLOBAL_LOCK_CURRENT_QUEUE_READERS: "#/components/schemas/RawMetricEventView" GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: "#/components/schemas/RawMetricEventView" CURSORS_TOTAL_OPEN: "#/components/schemas/RawMetricEventView" CURSORS_TOTAL_TIMED_OUT: "#/components/schemas/RawMetricEventView" CURSORS_TOTAL_CLIENT_CURSORS_SIZE: "#/components/schemas/RawMetricEventView" NETWORK_BYTES_IN: "#/components/schemas/DataMetricEventView" NETWORK_BYTES_OUT: "#/components/schemas/DataMetricEventView" NETWORK_NUM_REQUESTS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_TIME: "#/components/schemas/TimeMetricEventView" OPLOG_MASTER_TIME_ESTIMATED_TTL: "#/components/schemas/TimeMetricEventView" OPLOG_SLAVE_LAG_MASTER_TIME: "#/components/schemas/TimeMetricEventView" OPLOG_REPLICATION_LAG_TIME: "#/components/schemas/TimeMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" OPLOG_RATE_GB_PER_HOUR: "#/components/schemas/DataMetricEventView" EXTRA_INFO_PAGE_FAULTS: "#/components/schemas/RawMetricEventView" DB_STORAGE_TOTAL: "#/components/schemas/DataMetricEventView" DB_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricEventView" DB_DATA_SIZE_TOTAL_WO_SYSTEM: "#/components/schemas/DataMetricEventView" DB_INDEX_SIZE_TOTAL: "#/components/schemas/DataMetricEventView" JOURNALING_COMMITS_IN_WRITE_LOCK: "#/components/schemas/RawMetricEventView" JOURNALING_MB: "#/components/schemas/DataMetricEventView" JOURNALING_WRITE_DATA_FILES_MB: "#/components/schemas/DataMetricEventView" TICKETS_AVAILABLE_READS: "#/components/schemas/RawMetricEventView" TICKETS_AVAILABLE_WRITES: "#/components/schemas/RawMetricEventView" CACHE_USAGE_DIRTY: "#/components/schemas/DataMetricEventView" CACHE_USAGE_USED: "#/components/schemas/DataMetricEventView" CACHE_BYTES_READ_INTO: "#/components/schemas/DataMetricEventView" CACHE_BYTES_WRITTEN_FROM: "#/components/schemas/DataMetricEventView" NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricEventView" NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricEventView" 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_READ_IOPS_DATA: "#/components/schemas/RawMetricEventView" DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/RawMetricEventView" DISK_PARTITION_READ_IOPS_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_READ_LATENCY_DATA: "#/components/schemas/TimeMetricEventView" DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/TimeMetricEventView" DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/TimeMetricEventView" DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/TimeMetricEventView" DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/TimeMetricEventView" DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/TimeMetricEventView" DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/RawMetricEventView" DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/RawMetricEventView" DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/RawMetricEventView" FTS_DISK_UTILIZATION: "#/components/schemas/DataMetricEventView" MUNIN_CPU_USER: "#/components/schemas/RawMetricEventView" MUNIN_CPU_NICE: "#/components/schemas/RawMetricEventView" MUNIN_CPU_SYSTEM: "#/components/schemas/RawMetricEventView" MUNIN_CPU_IOWAIT: "#/components/schemas/RawMetricEventView" MUNIN_CPU_IRQ: "#/components/schemas/RawMetricEventView" MUNIN_CPU_SOFTIRQ: "#/components/schemas/RawMetricEventView" MUNIN_CPU_STEAL: "#/components/schemas/RawMetricEventView" DOCUMENT_RETURNED: "#/components/schemas/RawMetricEventView" DOCUMENT_INSERTED: "#/components/schemas/RawMetricEventView" DOCUMENT_UPDATED: "#/components/schemas/RawMetricEventView" DOCUMENT_DELETED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" QUERY_EXECUTOR_SCANNED: "#/components/schemas/RawMetricEventView" QUERY_EXECUTOR_SCANNED_OBJECTS: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" QUERY_SPILL_TO_DISK_DURING_SORT: "#/components/schemas/RawMetricEventView" QUERY_TARGETING_SCANNED_PER_RETURNED: "#/components/schemas/RawMetricEventView" QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: "#/components/schemas/RawMetricEventView" AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricEventView" AVG_WRITE_EXECUTION_TIME: "#/components/schemas/TimeMetricEventView" AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/TimeMetricEventView" LOGICAL_SIZE: "#/components/schemas/DataMetricEventView" RESTARTS_IN_LAST_HOUR: "#/components/schemas/RawMetricEventView" SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricEventView" SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricEventView" SWAP_USAGE_USED: "#/components/schemas/DataMetricEventView" SWAP_USAGE_FREE: "#/components/schemas/DataMetricEventView" SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricEventView" SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricEventView" MAX_NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricEventView" MAX_NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricEventView" 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_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_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_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_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_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_SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricEventView" MAX_SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricEventView" MAX_SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricEventView" MAX_SWAP_USAGE_USED: "#/components/schemas/DataMetricEventView" MAX_SWAP_USAGE_FREE: "#/components/schemas/DataMetricEventView" MAX_SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricEventView" MAX_SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricEventView" SEARCH_INDEX_SIZE: "#/components/schemas/DataMetricEventView" SEARCH_NUMBER_OF_FIELDS_IN_INDEX: "#/components/schemas/RawMetricEventView" SEARCH_REPLICATION_LAG: "#/components/schemas/TimeMetricEventView" SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: "#/components/schemas/NumberMetricEventView" SEARCH_OPCOUNTER_INSERT: "#/components/schemas/RawMetricEventView" SEARCH_OPCOUNTER_DELETE: "#/components/schemas/RawMetricEventView" SEARCH_OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" SEARCH_OPCOUNTER_GETMORE: "#/components/schemas/RawMetricEventView" SEARCH_NUMBER_OF_QUERIES_TOTAL: "#/components/schemas/RawMetricEventView" SEARCH_NUMBER_OF_QUERIES_ERROR: "#/components/schemas/RawMetricEventView" SEARCH_NUMBER_OF_QUERIES_SUCCESS: "#/components/schemas/RawMetricEventView" FTS_JVM_MAX_MEMORY: "#/components/schemas/DataMetricEventView" FTS_JVM_CURRENT_MEMORY: "#/components/schemas/DataMetricEventView" HostMetricEventTypeView: title: Host Metric Event Types type: string description: Unique identifier of event type. example: OUTSIDE_METRIC_THRESHOLD enum: - INSIDE_METRIC_THRESHOLD - OUTSIDE_METRIC_THRESHOLD HostMetricValue: type: object properties: number: type: number description: Amount of the **metricName** recorded at the time of the event. This value triggered the alert. format: double readOnly: true units: type: string 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. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion description: Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts. readOnly: true Link: type: object properties: href: type: string 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 rel: type: string 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 NDSAuditTypeViewForNdsGroup: title: NDS Audit Types type: string description: Unique identifier of event type. example: CLUSTER_CREATED enum: - CLUSTER_CREATED - CLUSTER_RESURRECTED - CLUSTER_READY - CLUSTER_UPDATE_SUBMITTED - CLUSTER_UPDATE_SUBMITTED_INTERNAL - 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_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_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 - UPDATE_BUMPER_FILES - 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_FAILURE_COUNT_RESET - PLAN_ASAP_REQUESTED - INDEPENDENT_SHARD_SCALING_AVAILABLE - 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 - SCHEDULED_MAINTENANCE - PROJECT_SCHEDULED_MAINTENANCE - PROJECT_LIMIT_UPDATED - PROJECT_OPERATIONAL_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 - 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_CLUSTER_UPGRADE_FROM_MTM - TENANT_SNAPSHOT_FAILED - TENANT_RESTORE_FAILED - SAMPLE_DATASET_LOAD_REQUESTED - CUSTOMER_X509_CRL_UPDATED - CONTAINER_SUBNETS_UPDATE_REQUESTED - CLEAR_UNPROVISIONED_TARGET_GROUPS_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 - 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 - ADMIN_NOTE_UPDATED - 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 - CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED - CLUSTER_FORCE_PLANNED - DATA_PROCESSING_REGION_UPDATED - 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 - 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_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_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 NDSAuditViewForNdsGroup: title: NDS Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 dbUserUsername: type: string description: The username of the MongoDB User that was created, deleted, or edited. readOnly: true example: user1 eventTypeName: "$ref": "#/components/schemas/NDSAuditTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 whitelistEntry: type: string description: Entry in the list of source host addresses that the API key accepts and this event targets. readOnly: true example: 0.0.0.0 description: NDS audit saving information about atlas cloud provider and other atlas related details. NDSAutoScalingAuditTypeViewForNdsGroup: title: NDS Auto Scaling Audit Types type: string description: Unique identifier of event type. example: COMPUTE_AUTO_SCALE_INITIATED 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_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 NDSAutoScalingAuditViewForNdsGroup: title: NDS Auto Scaling Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down. NDSServerlessInstanceAuditTypeView: title: NDS Serverless Instance Audit Types type: string description: Unique identifier of event type. example: SERVERLESS_INSTANCE_CREATED 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_BLOCKED - SERVERLESS_INSTANCE_UNBLOCKED NDSServerlessInstanceAuditView: title: NDS Serverless Instance Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/NDSServerlessInstanceAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: NDS serverless instance audit identifies any activities around serverless instance. NDSTenantEndpointAuditTypeView: title: NDS Auto Scaling Audit Types type: string description: Unique identifier of event type. example: TENANT_ENDPOINT_CREATED 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 NDSTenantEndpointAuditView: title: NDS Tenant Endpoint Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 endpointId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the endpoint associated with this event. readOnly: true example: 32b6e34b3d91647abb20e7b8 eventTypeName: "$ref": "#/components/schemas/NDSTenantEndpointAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 providerEndpointId: type: string description: Unique identification string that the cloud provider uses to identify the private endpoint. readOnly: true example: vpce-0d6c248dedef65a25 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down. NumberMetricEventView: required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/NumberMetricValueView" deskLocation: type: string description: Desk location of MongoDB employee associated with the event. readOnly: true employeeIdentifier: type: string description: Identifier of MongoDB employee associated with the event. readOnly: true eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. readOnly: true orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 NumberMetricUnits: title: Number Metric Units type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. example: COUNT enum: - COUNT - THOUSAND - MILLION - BILLION NumberMetricValueView: title: Number Metric Value type: object properties: number: type: number description: Amount of the **metricName** recorded at the time of the event. This value triggered the alert. format: double readOnly: true units: "$ref": "#/components/schemas/NumberMetricUnits" description: Measurement of the **metricName** recorded at the time of the event. readOnly: true RawMetricEventView: required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/RawMetricValueView" deskLocation: type: string description: Desk location of MongoDB employee associated with the event. readOnly: true employeeIdentifier: type: string description: Identifier of MongoDB employee associated with the event. readOnly: true eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. readOnly: true orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 RawMetricUnits: title: Raw Metric Units type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. default: RAW enum: - RAW RawMetricValueView: title: Raw Metric Value type: object properties: number: type: number description: Amount of the **metricName** recorded at the time of the event. This value triggered the alert. format: double readOnly: true units: "$ref": "#/components/schemas/RawMetricUnits" description: Measurement of the **metricName** recorded at the time of the event. readOnly: true ReplicaSetEventTypeViewForNdsGroup: title: ReplicaSet Event Types type: string description: Unique identifier of event type. example: PRIMARY_ELECTED 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 ResourceEventTypeView: title: Resource Event Types type: string description: Unique identifier of event type. example: TAGS_MODIFIED enum: - TAGS_MODIFIED - CLUSTER_TAGS_MODIFIED - GROUP_TAGS_MODIFIED ResourceEventViewForNdsGroup: title: Resource Events required: - created - eventTypeName - id - resourceType type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ResourceEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 resourceId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the resource associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 resourceType: type: string description: Unique identifier of resource type. example: cluster userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Resource event reflects different activities about resources. SearchDeploymentAuditTypeView: title: Search Deployment Audit Types type: string description: Unique identifier of event type. example: SEARCH_DEPLOYMENT_CREATED enum: - SEARCH_DEPLOYMENT_CREATED - SEARCH_DEPLOYMENT_UPDATED - SEARCH_DEPLOYMENT_DELETED SearchDeploymentAuditView: title: Search Deployment Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/SearchDeploymentAuditTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Indicates activities on decoupled search nodes. ServiceAccountEventTypeViewForNdsGroup: title: Service Account Event Types type: string 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 ServiceAccountGroupEvents: title: ServiceAccount Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Service Account event identifies different activities around user api keys. StreamProcessorEventTypeViewForNdsGroup: title: Stream Processor Event Types type: string description: Unique identifier of event type. example: STREAM_PROCESSOR_STATE_IS_FAILED enum: - STREAM_PROCESSOR_STATE_IS_FAILED - INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD StreamProcessorEventViewForNdsGroup: title: Stream Processor Events required: - created - eventTypeName - id type: object properties: created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 instanceName: type: string description: Name of the stream processing instance associated with the event. readOnly: true example: foobar links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 processorErrorMsg: type: string description: Error message linked to the stream processor associated with the event. readOnly: true example: invalid auth processorName: type: string description: Name of the stream processor associated with the event. readOnly: true example: foobar processorState: type: string description: State of the stream processor associated with the event. readOnly: true example: FAILED raw: "$ref": "#/components/schemas/raw" description: Stream Processor event identifies different activities about a stream processor in Atlas Streams. StreamsEventTypeViewForNdsGroup: title: Streams Event Types type: string description: Unique identifier of event type. example: MAX_PROCESSOR_COUNT_REACHED enum: - MAX_PROCESSOR_COUNT_REACHED StreamsEventViewForNdsGroup: title: Streams Events required: - created - eventTypeName - id type: object properties: created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/StreamsEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 instanceName: type: string description: Name of the stream processing instance associated with the event. readOnly: true example: foobar links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 raw: "$ref": "#/components/schemas/raw" description: Streams event identifies different activities about Atlas Streams. TeamEventTypeViewForNdsGroup: title: Team Event Types type: string description: Unique identifier of event type. example: TEAM_ADDED_TO_GROUP enum: - TEAM_ADDED_TO_GROUP - TEAM_REMOVED_FROM_GROUP - TEAM_ROLES_MODIFIED TeamEventViewForNdsGroup: title: Team Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/TeamEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 teamId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization team associated with this event. readOnly: true example: 32b6e34b3d91647abb20e7b8 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Team event identifies different activities around organization teams. TimeMetricEventView: required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/TimeMetricValueView" deskLocation: type: string description: Desk location of MongoDB employee associated with the event. readOnly: true employeeIdentifier: type: string description: Identifier of MongoDB employee associated with the event. readOnly: true eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. readOnly: true orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 port: type: integer description: IANA port on which the MongoDB process listens for requests. format: int32 readOnly: true example: 27017 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 replicaSetName: type: string description: Human-readable label of the replica set associated with the event. readOnly: true example: event-replica-set shardName: type: string description: Human-readable label of the shard associated with the event. readOnly: true example: event-sh-01 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 TimeMetricUnits: title: Time Metric Units type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. default: HOURS enum: - NANOSECONDS - MILLISECONDS - MILLION_MINUTES - SECONDS - MINUTES - HOURS - DAYS TimeMetricValueView: title: Time Metric Value type: object properties: number: type: number description: Amount of the **metricName** recorded at the time of the event. This value triggered the alert. format: double readOnly: true units: "$ref": "#/components/schemas/TimeMetricUnits" description: Measurement of the **metricName** recorded at the time of the event. readOnly: true UserEventTypeViewForNdsGroup: title: User Event Types type: string description: Unique identifier of event type. example: JOINED_GROUP 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 UserEventViewForNdsGroup: title: User Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/UserEventTypeViewForNdsGroup" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 targetUsername: type: string description: 'Email address for the console user that this event targets. The resource returns this parameter when `"eventTypeName" : "USER"`.' format: email readOnly: true example: test.user@mongodb.com userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: User event reflects different activities about the atlas user. raw: type: object properties: _t: type: string description: Unique identifier of event type. example: ALERT_AUDIT x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration related to the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 cid: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. readOnly: true example: 32b6e34b3d91647abb20e7b8 cre: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: type: string description: Description of the event. example: Alert Acknowledged gn: maxLength: 64 minLength: 1 type: string description: Human-readable label that identifies the project. example: Test Project id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 orgName: maxLength: 64 minLength: 1 type: string description: Human-readable label that identifies the organization that contains the project. example: Test Organization severity: type: string description: Severity of the event. enum: - INFO - WARNING - ERROR - CRITICAL 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. readOnly: true EventTypeForNdsGroup: type: object oneOf: - title: Alert Audit Types type: string 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: API User Event 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: Service Account 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: App Services 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: Auto Indexing 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: Automation Config Event Types type: string enum: - AUTOMATION_CONFIG_PUBLISHED_AUDIT - title: AWS Peer Vpc Audit Types type: string enum: - PEER_CREATED - PEER_DELETED - PEER_UPDATED - title: Azure Peer Network Audit Types type: string enum: - AZURE_PEER_CREATED - AZURE_PEER_UPDATED - AZURE_PEER_ACTIVE - AZURE_PEER_DELETED - title: Billing Event 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 - title: Cluster Connection 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 - title: Cluster Event Types type: string enum: - CLUSTER_MONGOS_IS_PRESENT - CLUSTER_MONGOS_IS_MISSING - title: Cps Backup 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_AUTO_EXPORT_FAILED - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED - CPS_OPLOG_BEHIND - CPS_OPLOG_CAUGHT_UP - title: Data Explorer Accessed Event Types type: string enum: - DATA_EXPLORER - DATA_EXPLORER_CRUD_ATTEMPT - DATA_EXPLORER_CRUD_ERROR - DATA_EXPLORER_CRUD - title: Data Explorer Event Types type: string enum: - DATA_EXPLORER_SESSION_CREATED - title: CPS Backup Compliance Policy 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: Disk Backup 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: Encryption 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: Export Bucket Audit Types type: string enum: - BUCKET_CREATED_AUDIT - BUCKET_DELETED_AUDIT - title: FTS Index 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_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED - FTS_INDEXES_SYNONYM_MAPPING_INVALID - title: GCP Peer Vpc Audit Types type: string enum: - GCP_PEER_CREATED - GCP_PEER_DELETED - GCP_PEER_UPDATED - GCP_PEER_ACTIVE - GCP_PEER_INACTIVE - title: Group 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 - title: Group Event 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 - title: Group Integration Event Types type: string enum: - INTEGRATION_CONFIGURED - INTEGRATION_REMOVED - title: Host Event Types type: string enum: - AUTO_CREATED_INDEX_AUDIT - 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_SUFFICIENT_DISK_SPACE - HOST_MONGOT_APPROACHING_STOP_REPLICATION - 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 - 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 - title: Host Metric Event Types type: string enum: - INSIDE_METRIC_THRESHOLD - OUTSIDE_METRIC_THRESHOLD - title: Index Build Audit Types type: string enum: - ROLLING_INDEX_FAILED_INDEX_BUILD - ROLLING_INDEX_SUCCESS_INDEX_BUILD - INDEX_FAILED_INDEX_BUILD - INDEX_SUCCESS_INDEX_BUILD - title: NDS Audit Types type: string enum: - CLUSTER_CREATED - CLUSTER_RESURRECTED - CLUSTER_READY - CLUSTER_UPDATE_SUBMITTED - CLUSTER_UPDATE_SUBMITTED_INTERNAL - 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_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_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 - UPDATE_BUMPER_FILES - 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_FAILURE_COUNT_RESET - PLAN_ASAP_REQUESTED - INDEPENDENT_SHARD_SCALING_AVAILABLE - 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 - SCHEDULED_MAINTENANCE - PROJECT_SCHEDULED_MAINTENANCE - PROJECT_LIMIT_UPDATED - PROJECT_OPERATIONAL_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 - 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_CLUSTER_UPGRADE_FROM_MTM - TENANT_SNAPSHOT_FAILED - TENANT_RESTORE_FAILED - SAMPLE_DATASET_LOAD_REQUESTED - CUSTOMER_X509_CRL_UPDATED - CONTAINER_SUBNETS_UPDATE_REQUESTED - CLEAR_UNPROVISIONED_TARGET_GROUPS_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 - 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 - ADMIN_NOTE_UPDATED - 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 - CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED - CLUSTER_FORCE_PLANNED - DATA_PROCESSING_REGION_UPDATED - 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 - 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_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_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 - title: NDS DB Check Audit Types type: string enum: - DB_CHECK_SUBMITTED - 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: NDS Data Validation Audit Types type: string enum: - CLUSTER_SAMPLED_FOR_DATA_VALIDATION - DATA_VALIDATION_SUBMITTED_FOR_CLUSTER - CLUSTER_OPTED_OUT_OF_DATA_VALIDATION - title: NDS Auto Scaling 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_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 - title: NDS Maintenance Window Audit Types type: string enum: - MAINTENANCE_IN_ADVANCED - MAINTENANCE_AUTO_DEFERRED - MAINTENANCE_STARTED - MAINTENANCE_NO_LONGER_NEEDED - title: NDS Serverless Auto Scaling 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: NDS Serverless Instance 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_BLOCKED - SERVERLESS_INSTANCE_UNBLOCKED - title: NDS Auto Scaling 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: NDS Tenant Endpoint Service Deployment 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: NDS x509 User Auth Event 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: Online Archive 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: Private Link Audit Types type: string enum: - ENDPOINT_SERVICE_CREATED - ENDPOINT_SERVICE_DELETED - INTERFACE_ENDPOINT_CREATED - INTERFACE_ENDPOINT_DELETED - INTERFACE_ENDPOINT_PATCHED - title: Proactive Operation Event Types type: string enum: - PROACTIVE_OPERATION_EVENT_LOGGED - title: ReplicaSet 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: Search Deployment Audit Types type: string enum: - SEARCH_DEPLOYMENT_CREATED - SEARCH_DEPLOYMENT_UPDATED - SEARCH_DEPLOYMENT_DELETED - title: Serverless 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 Event Types type: string enum: - INSIDE_SERVERLESS_METRIC_THRESHOLD - OUTSIDE_SERVERLESS_METRIC_THRESHOLD - title: Flex Metric Event Types type: string enum: - INSIDE_FLEX_METRIC_THRESHOLD - OUTSIDE_FLEX_METRIC_THRESHOLD - title: Setup Serverless Audit Types type: string enum: - SETUP_SERVERLESS_INITIATED - title: Streams Event Types type: string enum: - MAX_PROCESSOR_COUNT_REACHED - title: Stream Processor Event Types type: string enum: - STREAM_PROCESSOR_STATE_IS_FAILED - INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - title: Support Case Event Types type: string enum: - CASE_CREATED - title: Support Event Types type: string enum: - SUPPORT_EMAILS_SENT_SUCCESSFULLY - SUPPORT_EMAILS_SENT_FAILURE - title: Team Event Types type: string enum: - TEAM_ADDED_TO_GROUP - TEAM_REMOVED_FROM_GROUP - TEAM_ROLES_MODIFIED - title: Tenant Backup 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: User 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: Version Audit Types type: string enum: - CLUSTER_VERSION_FIXED - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - ACME_PROVIDER_FIXED - ACME_PROVIDER_UNFIXED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED - CLUSTER_BINARY_VERSION_DOWNGRADED - CLUSTER_BINARY_VERSION_UPGRADED - CLUSTER_OS_FIXED - CLUSTER_OS_UNFIXED - title: Resource Event Types type: string enum: - TAGS_MODIFIED - CLUSTER_TAGS_MODIFIED - GROUP_TAGS_MODIFIED - title: Access Event Types type: string enum: - EMPLOYEE_DOWNLOADED_CLUSTER_LOGS - title: Charts Api Call Audit Types type: string enum: - CHARTS_API_SUCCESS - CHARTS_API_FAILURE - title: Atlas Resource Policy Audit Types type: string enum: - RESOURCE_POLICY_VIOLATED ApiUserEventTypeViewForOrg: title: API User Event Types type: string description: Unique identifier of event type. example: API_KEY_CREATED 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 ApiUserEventViewForOrg: title: API User Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ApiUserEventTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 targetPublicKey: type: string description: Public part of the API key that this event targets. readOnly: true example: zmmrboas userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 whitelistEntry: type: string description: Entry in the list of source host addresses that the API key accepts and this event targets. readOnly: true example: 0.0.0.0 description: API User event identifies different activities around user api keys. AtlasResourcePolicyAuditForOrg: title: Atlas Resource Policy Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: title: Atlas Resource Policy Audit Types type: string description: Unique identifier of event type. example: RESOURCE_POLICY_CREATED enum: - RESOURCE_POLICY_CREATED - RESOURCE_POLICY_MODIFIED - RESOURCE_POLICY_DELETED - RESOURCE_POLICY_VIOLATED groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 resourcePolicyId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the resource policy. readOnly: true example: 32b6e34b3d91647abb20e7b8 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Atlas resource policy audits indicate org level changes to resource policies BillingEventTypeViewForOrg: title: Billing Event Types type: string description: Unique identifier of event type. example: CHARGE_SUCCEEDED enum: - CHARGE_SUCCEEDED - CHARGE_FAILED - CHARGE_PROCESSING - CHARGE_PENDING_REVERSAL - BRAINTREE_CHARGE_FAILED - INVOICE_CLOSED - CHECK_PAYMENT_RECEIVED - WIRE_TRANSFER_PAYMENT_RECEIVED - DISCOUNT_APPLIED - CREDIT_ISSUED - CREDIT_PULLED_FWD - CREDIT_END_DATE_MODIFIED - PROMO_CODE_APPLIED - PAYMENT_FORGIVEN - REFUND_ISSUED - ACCOUNT_DOWNGRADED - ACCOUNT_UPGRADED - ACCOUNT_MODIFIED - SUPPORT_PLAN_ACTIVATED - SUPPORT_PLAN_CANCELLED - SUPPORT_PLAN_CANCELLATION_SCHEDULED - INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC - INVOICE_ADDRESS_CHANGED - INVOICE_ADDRESS_ADDED - PREPAID_PLAN_ACTIVATED - ELASTIC_INVOICING_MODE_ACTIVATED - ELASTIC_INVOICING_MODE_DEACTIVATED - TERMINATE_PAID_SERVICES - BILLING_EMAIL_ADDRESS_ADDED - BILLING_EMAIL_ADDRESS_CHANGED - BILLING_EMAIL_ADDRESS_REMOVED - AWS_BILLING_ACCOUNT_CREDIT_ISSUED - GCP_BILLING_ACCOUNT_CREDIT_ISSUED - CREDIT_SFOLID_MODIFIED - PREPAID_PLAN_MODIFIED - AWS_USAGE_REPORTED - AZURE_USAGE_REPORTED - GCP_USAGE_REPORTED - VERCEL_USAGE_REPORTED - BECAME_PAYING_ORG - NEW_LINKED_ORG - UNLINKED_ORG - ORG_LINKED_TO_PAYING_ORG - ORG_UNLINKED_FROM_PAYING_ORG - ORG_UNLINK_REQUESTED - ORG_UNLINK_CANCELLED - PAYMENT_UPDATED_THROUGH_API - AZURE_BILLING_ACCOUNT_CREDIT_ISSUED - CREDIT_START_DATE_MODIFIED - CREDIT_ELASTIC_INVOICING_MODIFIED - CREDIT_TYPE_MODIFIED - CREDIT_AMOUNT_CENTS_MODIFIED - CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED - CREDIT_TOTAL_BILLED_CENTS_MODIFIED - CREDIT_AWS_CUSTOMER_ID_MODIFIED - CREDIT_AWS_PRODUCT_CODE_MODIFIED - CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED - CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED - CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED - TARGETED_REBILL_EXECUTED - LEGACY_REBILL_EXECUTED - EVERGREEN_DEAL_CANCELLED - GRACE_PERIOD_ACTIVATED - GRACE_PERIOD_NO_LONGER_IN_EFFECT - PENDING_DEAL_ACTIVATION_ADDED - PENDING_DEAL_ACTIVATION_CANCELED - PENDING_DEAL_APPLIED - PENDING_DEAL_ACTIVATION_FAILED - EVERGREEN_PRIORITY_MODIFIED BillingEventViewForOrg: title: Billing Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/BillingEventTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 invoiceId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 paymentId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Billing event identifies different activities related to billing, payment or financial status change of an organization. DefaultEventViewForOrg: title: Any Other Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: type: object description: Unique identifier of event type. oneOf: - title: Federation Settings 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: Group Audit Types type: string enum: - GROUP_DELETED - GROUP_CREATED - GROUP_MOVED - title: Mlab Migration 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: Partner 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_PAID - VERCEL_INVOICE_REFUNDED - title: Support Event Types type: string enum: - SUPPORT_EMAILS_SENT_SUCCESSFULLY - SUPPORT_EMAILS_SENT_FAILURE groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Other events which don't have extra details beside of basic one. EventViewForOrg: type: object x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation 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" NDSAuditTypeViewForOrg: title: NDS Audit Types type: string description: Unique identifier of event type. example: ORG_LIMIT_UPDATED enum: - ORG_LIMIT_UPDATED NDSAuditViewForOrg: title: NDS Audits required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 dbUserUsername: type: string description: The username of the MongoDB User that was created, deleted, or edited. readOnly: true example: user1 eventTypeName: "$ref": "#/components/schemas/NDSAuditTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 whitelistEntry: type: string description: Entry in the list of source host addresses that the API key accepts and this event targets. readOnly: true example: 0.0.0.0 description: NDS audit saving information about atlas cloud provider and other atlas related details. OrgEventTypeViewForOrg: title: Org Event Types type: string description: Unique identifier of event type. example: ORG_CREATED 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_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_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_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_SFDC_ACCOUNT_ID_CHANGED - 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 - GROUP_MOVED_FROM_ORG - SANDBOX_ENABLED_FOR_ORG - SANDBOX_DISABLED_FOR_ORG OrgEventViewForOrg: title: Org Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/OrgEventTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 invoiceId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Org event identifies different activities and changes in an organization settings. OrgPaginatedEventView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/EventViewForOrg" totalCount: minimum: 0 type: integer 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 readOnly: true ResourceEventTypeViewForOrg: title: Resource Event Types type: string description: Unique identifier of event type. example: GROUP_TAGS_MODIFIED enum: - TAGS_MODIFIED - GROUP_TAGS_MODIFIED ResourceEventViewForOrg: title: Resource Events required: - created - eventTypeName - id - resourceType type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ResourceEventTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 resourceId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the resource associated with the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 resourceType: type: string description: Unique identifier of resource type. example: cluster userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Resource event reflects different activities about resources. ServiceAccountEventTypeViewForOrg: title: Service Account Event Types type: string 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 ServiceAccountOrgEvents: title: ServiceAccount Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ServiceAccountEventTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Service Account event identifies different activities around user api keys. TeamEvent: title: Team Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/TeamEventTypeView" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 teamId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization team associated with this event. readOnly: true example: 32b6e34b3d91647abb20e7b8 userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: Team event identifies different activities around organization teams. TeamEventTypeView: title: Team Event Types type: string description: Unique identifier of event type. example: TEAM_ADDED_TO_GROUP enum: - TEAM_CREATED - TEAM_DELETED - TEAM_UPDATED - TEAM_NAME_CHANGED - TEAM_ADDED_TO_GROUP - TEAM_REMOVED_FROM_GROUP - TEAM_ROLES_MODIFIED UserEventTypeViewForOrg: title: User Event Types type: string description: Unique identifier of event type. example: JOINED_ORG 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 UserEventViewForOrg: title: User Events required: - created - eventTypeName - id type: object properties: apiKeyId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Create Programmatic API Key url: https://dochub.mongodb.org/core/atlas-create-prog-api-key created: type: string description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/UserEventTypeViewForOrg" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the event. readOnly: true example: 32b6e34b3d91647abb20e7b8 isGlobalAdmin: type: boolean description: Flag that indicates whether a MongoDB employee triggered the specified event. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: type: string description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. readOnly: true externalDocs: url: https://dochub.mongodb.org/core/atlas-create-prog-api-key raw: "$ref": "#/components/schemas/raw" remoteAddress: 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: IPv4 or IPv6 address from which the user triggered this event. readOnly: true example: 216.172.40.186 targetUsername: type: string description: 'Email address for the console user that this event targets. The resource returns this parameter when `"eventTypeName" : "USER"`.' format: email readOnly: true example: test.user@mongodb.com userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. readOnly: true example: 32b6e34b3d91647abb20e7b8 username: type: string 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 description: User event reflects different activities about the atlas user. EventTypeForOrg: type: object oneOf: - title: Alert Audit Types type: string 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: API User Event 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: Service Account 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: Billing Event Types type: string enum: - CHARGE_SUCCEEDED - CHARGE_FAILED - CHARGE_PROCESSING - CHARGE_PENDING_REVERSAL - BRAINTREE_CHARGE_FAILED - INVOICE_CLOSED - CHECK_PAYMENT_RECEIVED - WIRE_TRANSFER_PAYMENT_RECEIVED - DISCOUNT_APPLIED - CREDIT_ISSUED - CREDIT_PULLED_FWD - CREDIT_END_DATE_MODIFIED - PROMO_CODE_APPLIED - PAYMENT_FORGIVEN - REFUND_ISSUED - ACCOUNT_DOWNGRADED - ACCOUNT_UPGRADED - ACCOUNT_MODIFIED - SUPPORT_PLAN_ACTIVATED - SUPPORT_PLAN_CANCELLED - SUPPORT_PLAN_CANCELLATION_SCHEDULED - INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC - INVOICE_ADDRESS_CHANGED - INVOICE_ADDRESS_ADDED - PREPAID_PLAN_ACTIVATED - ELASTIC_INVOICING_MODE_ACTIVATED - ELASTIC_INVOICING_MODE_DEACTIVATED - TERMINATE_PAID_SERVICES - BILLING_EMAIL_ADDRESS_ADDED - BILLING_EMAIL_ADDRESS_CHANGED - BILLING_EMAIL_ADDRESS_REMOVED - AWS_BILLING_ACCOUNT_CREDIT_ISSUED - GCP_BILLING_ACCOUNT_CREDIT_ISSUED - CREDIT_SFOLID_MODIFIED - PREPAID_PLAN_MODIFIED - AWS_USAGE_REPORTED - AZURE_USAGE_REPORTED - GCP_USAGE_REPORTED - VERCEL_USAGE_REPORTED - BECAME_PAYING_ORG - NEW_LINKED_ORG - UNLINKED_ORG - ORG_LINKED_TO_PAYING_ORG - ORG_UNLINKED_FROM_PAYING_ORG - ORG_UNLINK_REQUESTED - ORG_UNLINK_CANCELLED - PAYMENT_UPDATED_THROUGH_API - AZURE_BILLING_ACCOUNT_CREDIT_ISSUED - CREDIT_START_DATE_MODIFIED - CREDIT_ELASTIC_INVOICING_MODIFIED - CREDIT_TYPE_MODIFIED - CREDIT_AMOUNT_CENTS_MODIFIED - CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED - CREDIT_TOTAL_BILLED_CENTS_MODIFIED - CREDIT_AWS_CUSTOMER_ID_MODIFIED - CREDIT_AWS_PRODUCT_CODE_MODIFIED - CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED - CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED - CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED - TARGETED_REBILL_EXECUTED - LEGACY_REBILL_EXECUTED - EVERGREEN_DEAL_CANCELLED - GRACE_PERIOD_ACTIVATED - GRACE_PERIOD_NO_LONGER_IN_EFFECT - PENDING_DEAL_ACTIVATION_ADDED - PENDING_DEAL_ACTIVATION_CANCELED - PENDING_DEAL_APPLIED - PENDING_DEAL_ACTIVATION_FAILED - EVERGREEN_PRIORITY_MODIFIED - title: Federation Settings 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: Group Audit Types type: string enum: - GROUP_DELETED - GROUP_CREATED - GROUP_MOVED - title: Mlab Migration 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: NDS Audit Types type: string enum: - ORG_LIMIT_UPDATED - title: Org Event 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_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_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_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_SFDC_ACCOUNT_ID_CHANGED - 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 - GROUP_MOVED_FROM_ORG - SANDBOX_ENABLED_FOR_ORG - SANDBOX_DISABLED_FOR_ORG - title: Partner 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_PAID - VERCEL_INVOICE_REFUNDED - title: Support Event Types type: string enum: - SUPPORT_EMAILS_SENT_SUCCESSFULLY - SUPPORT_EMAILS_SENT_FAILURE - title: Team 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: User 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: Resource Event Types type: string enum: - TAGS_MODIFIED - GROUP_TAGS_MODIFIED - title: Atlas Resource Policy Audit Types type: string enum: - RESOURCE_POLICY_CREATED - RESOURCE_POLICY_MODIFIED - RESOURCE_POLICY_DELETED - RESOURCE_POLICY_VIOLATED AlertViewForNdsGroup: type: object x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation 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" AppServiceAlertView: title: App Services Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/AppServiceEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: App Services alert notifies different activities about a BAAS application. AppServiceEventTypeViewAlertable: title: App Services Event Types type: string description: Incident that triggered this alert. readOnly: true example: DEPLOYMENT_FAILURE 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 ClusterAlertViewForNdsGroup: title: Cluster Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroupAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Cluster alert notifies different activities and conditions about cluster of mongod hosts. ClusterEventTypeViewForNdsGroupAlertable: title: Cluster Event Types type: string description: Event type that triggers an alert. example: CLUSTER_MONGOS_IS_MISSING enum: - CLUSTER_MONGOS_IS_MISSING DataMetricAlertView: required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/DataMetricValueView" eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: |- Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see Host Metrics. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements. readOnly: true example: ASSERT_USER x-xgen-IPA-exception: xgen-IPA-117-description-must-not-use-html: Description predates IPA validation orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 DefaultAlertViewForNdsGroup: title: Any Other Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: type: object description: Incident that triggered this alert. readOnly: true oneOf: - title: Billing Event Types type: string enum: - CREDIT_CARD_ABOUT_TO_EXPIRE - PENDING_INVOICE_OVER_THRESHOLD - DAILY_BILL_OVER_THRESHOLD - title: Cps Backup 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_AUTO_EXPORT_FAILED - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED - CPS_OPLOG_BEHIND - CPS_OPLOG_CAUGHT_UP - title: Encryption 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: FTS Index Audit Types type: string enum: - FTS_INDEX_DELETION_FAILED - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED - FTS_INDEXES_SYNONYM_MAPPING_INVALID - title: Group Event Types type: string enum: - USERS_WITHOUT_MULTI_FACTOR_AUTH - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID - title: NDS Audit 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: NDS Maintenance Window Audit Types type: string enum: - MAINTENANCE_IN_ADVANCED - MAINTENANCE_AUTO_DEFERRED - MAINTENANCE_STARTED - MAINTENANCE_NO_LONGER_NEEDED - title: NDS x509 User Auth Event 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: Online Archive Event Types type: string enum: - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK - title: Serverless Event Types type: string enum: - OUTSIDE_SERVERLESS_METRIC_THRESHOLD - title: Flex Metric Event Types type: string enum: - OUTSIDE_FLEX_METRIC_THRESHOLD - title: User Event Types type: string enum: - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT - title: Resource Event Types type: string enum: - TAGS_MODIFIED - CLUSTER_TAGS_MODIFIED - GROUP_TAGS_MODIFIED - title: Stream Processor Event Types type: string enum: - STREAM_PROCESSOR_STATE_IS_FAILED - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - title: NDS Auto Scaling Audit 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 - title: Data Protection 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: Atlas Resource Policy Audit Types type: string enum: - RESOURCE_POLICY_VIOLATED groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Other alerts which don't have extra details beside of basic one. HostAlertViewForNdsGroup: title: Host Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Host alert notifies about activities on mongod host. HostEventTypeViewForNdsGroupAlertable: title: Host Event Types type: string description: Event type that triggers an alert. example: HOST_DOWN enum: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_STOP_REPLICATION - HOST_MONGOT_APPROACHING_STOP_REPLICATION - 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 HostMetricAlert: title: Host Metric Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/HostMetricValue" eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: |- Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see Host Metrics. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements. readOnly: true example: ASSERT_USER x-xgen-IPA-exception: xgen-IPA-117-description-must-not-use-html: Description predates IPA validation orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Host Metric Alert notifies about changes of measurements or metrics for mongod host. discriminator: propertyName: metricName mapping: ASSERT_REGULAR: "#/components/schemas/RawMetricAlertView" ASSERT_WARNING: "#/components/schemas/RawMetricAlertView" ASSERT_MSG: "#/components/schemas/RawMetricAlertView" ASSERT_USER: "#/components/schemas/RawMetricAlertView" OPCOUNTER_CMD: "#/components/schemas/RawMetricAlertView" OPCOUNTER_QUERY: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_DELETE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_TTL_DELETED: "#/components/schemas/RawMetricAlertView" OPCOUNTER_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_GETMORE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_CMD: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_DELETE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" FTS_MEMORY_RESIDENT: "#/components/schemas/DataMetricAlertView" FTS_MEMORY_VIRTUAL: "#/components/schemas/DataMetricAlertView" FTS_MEMORY_MAPPED: "#/components/schemas/DataMetricAlertView" FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricAlertView" FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricAlertView" NORMALIZED_FTS_PROCESS_CPU_USER: "#/components/schemas/RawMetricAlertView" NORMALIZED_FTS_PROCESS_CPU_KERNEL: "#/components/schemas/RawMetricAlertView" SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricAlertView" MEMORY_RESIDENT: "#/components/schemas/DataMetricAlertView" MEMORY_VIRTUAL: "#/components/schemas/DataMetricAlertView" MEMORY_MAPPED: "#/components/schemas/DataMetricAlertView" COMPUTED_MEMORY: "#/components/schemas/DataMetricAlertView" 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" GLOBAL_LOCK_PERCENTAGE: "#/components/schemas/RawMetricAlertView" BACKGROUND_FLUSH_AVG: "#/components/schemas/TimeMetricAlertView" CONNECTIONS: "#/components/schemas/RawMetricAlertView" CONNECTIONS_MAX: "#/components/schemas/RawMetricAlertView" CONNECTIONS_PERCENT: "#/components/schemas/RawMetricAlertView" GLOBAL_ACCESSES_NOT_IN_MEMORY: "#/components/schemas/RawMetricAlertView" GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: "#/components/schemas/RawMetricAlertView" GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: "#/components/schemas/RawMetricAlertView" GLOBAL_LOCK_CURRENT_QUEUE_READERS: "#/components/schemas/RawMetricAlertView" GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: "#/components/schemas/RawMetricAlertView" CURSORS_TOTAL_OPEN: "#/components/schemas/RawMetricAlertView" CURSORS_TOTAL_TIMED_OUT: "#/components/schemas/RawMetricAlertView" CURSORS_TOTAL_CLIENT_CURSORS_SIZE: "#/components/schemas/RawMetricAlertView" NETWORK_BYTES_IN: "#/components/schemas/DataMetricAlertView" NETWORK_BYTES_OUT: "#/components/schemas/DataMetricAlertView" NETWORK_NUM_REQUESTS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_TIME: "#/components/schemas/TimeMetricAlertView" OPLOG_MASTER_TIME_ESTIMATED_TTL: "#/components/schemas/TimeMetricAlertView" OPLOG_SLAVE_LAG_MASTER_TIME: "#/components/schemas/TimeMetricAlertView" OPLOG_REPLICATION_LAG_TIME: "#/components/schemas/TimeMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" OPLOG_RATE_GB_PER_HOUR: "#/components/schemas/DataMetricAlertView" EXTRA_INFO_PAGE_FAULTS: "#/components/schemas/RawMetricAlertView" DB_STORAGE_TOTAL: "#/components/schemas/DataMetricAlertView" DB_DATA_SIZE_TOTAL: "#/components/schemas/DataMetricAlertView" DB_DATA_SIZE_TOTAL_WO_SYSTEM: "#/components/schemas/DataMetricAlertView" DB_INDEX_SIZE_TOTAL: "#/components/schemas/DataMetricAlertView" JOURNALING_COMMITS_IN_WRITE_LOCK: "#/components/schemas/RawMetricAlertView" JOURNALING_MB: "#/components/schemas/DataMetricAlertView" JOURNALING_WRITE_DATA_FILES_MB: "#/components/schemas/DataMetricAlertView" TICKETS_AVAILABLE_READS: "#/components/schemas/RawMetricAlertView" TICKETS_AVAILABLE_WRITES: "#/components/schemas/RawMetricAlertView" CACHE_USAGE_DIRTY: "#/components/schemas/DataMetricAlertView" CACHE_USAGE_USED: "#/components/schemas/DataMetricAlertView" CACHE_BYTES_READ_INTO: "#/components/schemas/DataMetricAlertView" CACHE_BYTES_WRITTEN_FROM: "#/components/schemas/DataMetricAlertView" NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricAlertView" NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricAlertView" 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_READ_IOPS_DATA: "#/components/schemas/RawMetricAlertView" DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/RawMetricAlertView" DISK_PARTITION_READ_IOPS_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_READ_LATENCY_DATA: "#/components/schemas/TimeMetricAlertView" DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/TimeMetricAlertView" DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/TimeMetricAlertView" DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/TimeMetricAlertView" DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/TimeMetricAlertView" DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/TimeMetricAlertView" DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/RawMetricAlertView" DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/RawMetricAlertView" DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/RawMetricAlertView" FTS_DISK_UTILIZATION: "#/components/schemas/DataMetricAlertView" MUNIN_CPU_USER: "#/components/schemas/RawMetricAlertView" MUNIN_CPU_NICE: "#/components/schemas/RawMetricAlertView" MUNIN_CPU_SYSTEM: "#/components/schemas/RawMetricAlertView" MUNIN_CPU_IOWAIT: "#/components/schemas/RawMetricAlertView" MUNIN_CPU_IRQ: "#/components/schemas/RawMetricAlertView" MUNIN_CPU_SOFTIRQ: "#/components/schemas/RawMetricAlertView" MUNIN_CPU_STEAL: "#/components/schemas/RawMetricAlertView" DOCUMENT_RETURNED: "#/components/schemas/RawMetricAlertView" DOCUMENT_INSERTED: "#/components/schemas/RawMetricAlertView" DOCUMENT_UPDATED: "#/components/schemas/RawMetricAlertView" DOCUMENT_DELETED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" QUERY_EXECUTOR_SCANNED: "#/components/schemas/RawMetricAlertView" QUERY_EXECUTOR_SCANNED_OBJECTS: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" QUERY_SPILL_TO_DISK_DURING_SORT: "#/components/schemas/RawMetricAlertView" QUERY_TARGETING_SCANNED_PER_RETURNED: "#/components/schemas/RawMetricAlertView" QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: "#/components/schemas/RawMetricAlertView" AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricAlertView" AVG_WRITE_EXECUTION_TIME: "#/components/schemas/TimeMetricAlertView" AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/TimeMetricAlertView" LOGICAL_SIZE: "#/components/schemas/DataMetricAlertView" RESTARTS_IN_LAST_HOUR: "#/components/schemas/RawMetricAlertView" SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricAlertView" SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricAlertView" SWAP_USAGE_USED: "#/components/schemas/DataMetricAlertView" SWAP_USAGE_FREE: "#/components/schemas/DataMetricAlertView" SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricAlertView" SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricAlertView" MAX_NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/RawMetricAlertView" MAX_NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/RawMetricAlertView" 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_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_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_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_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_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_SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/RawMetricAlertView" MAX_SYSTEM_MEMORY_USED: "#/components/schemas/DataMetricAlertView" MAX_SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/DataMetricAlertView" MAX_SWAP_USAGE_USED: "#/components/schemas/DataMetricAlertView" MAX_SWAP_USAGE_FREE: "#/components/schemas/DataMetricAlertView" MAX_SYSTEM_NETWORK_IN: "#/components/schemas/DataMetricAlertView" MAX_SYSTEM_NETWORK_OUT: "#/components/schemas/DataMetricAlertView" SEARCH_INDEX_SIZE: "#/components/schemas/DataMetricAlertView" SEARCH_NUMBER_OF_FIELDS_IN_INDEX: "#/components/schemas/RawMetricAlertView" SEARCH_REPLICATION_LAG: "#/components/schemas/TimeMetricAlertView" SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: "#/components/schemas/NumberMetricAlertView" SEARCH_OPCOUNTER_INSERT: "#/components/schemas/RawMetricAlertView" SEARCH_OPCOUNTER_DELETE: "#/components/schemas/RawMetricAlertView" SEARCH_OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" SEARCH_OPCOUNTER_GETMORE: "#/components/schemas/RawMetricAlertView" SEARCH_NUMBER_OF_QUERIES_TOTAL: "#/components/schemas/RawMetricAlertView" SEARCH_NUMBER_OF_QUERIES_ERROR: "#/components/schemas/RawMetricAlertView" SEARCH_NUMBER_OF_QUERIES_SUCCESS: "#/components/schemas/RawMetricAlertView" FTS_JVM_MAX_MEMORY: "#/components/schemas/DataMetricAlertView" FTS_JVM_CURRENT_MEMORY: "#/components/schemas/DataMetricAlertView" HostMetricEventTypeViewAlertable: title: Host Metric Event Types type: string description: Event type that triggers an alert. example: OUTSIDE_METRIC_THRESHOLD enum: - OUTSIDE_METRIC_THRESHOLD NumberMetricAlertView: required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/NumberMetricValueView" eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: |- Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see Host Metrics. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements. readOnly: true example: ASSERT_USER x-xgen-IPA-exception: xgen-IPA-117-description-must-not-use-html: Description predates IPA validation orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 PaginatedAlertView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/AlertViewForNdsGroup" totalCount: minimum: 0 type: integer 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 readOnly: true RawMetricAlertView: required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/RawMetricValueView" eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: |- Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see Host Metrics. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements. readOnly: true example: ASSERT_USER x-xgen-IPA-exception: xgen-IPA-117-description-must-not-use-html: Description predates IPA validation orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 ReplicaSetAlertViewForNdsGroup: title: ReplicaSet Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" nonRunningHostIds: type: array description: List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{8,32})$" type: string readOnly: true example: 32b6e34b3d91647abb20e7b8 orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 parentClusterId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: ReplicaSet alert notifies about different activities on replica set of mongod instances. ReplicaSetEventTypeViewForNdsGroupAlertable: title: ReplicaSet Event Types type: string description: Incident that triggered this alert. readOnly: true example: NO_PRIMARY enum: - REPLICATION_OPLOG_WINDOW_RUNNING_OUT - NO_PRIMARY - PRIMARY_ELECTED - TOO_MANY_ELECTIONS - TOO_FEW_HEALTHY_MEMBERS - TOO_MANY_UNHEALTHY_MEMBERS StreamProcessorAlertViewForNdsGroup: title: Stream Processor Alerts required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 eventTypeName: "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 instanceName: type: string description: The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances. readOnly: true example: foobar lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 processorErrorMsg: type: string description: The error message associated with the Stream Processor to which this alert applies. readOnly: true 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)' processorName: type: string description: The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors. readOnly: true example: foobar processorState: type: string description: The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors. readOnly: true example: STARTED resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Stream Processor alert notifies about activities on Stream Processor in AtlasStreams. TimeMetricAlertView: required: - alertConfigId - created - eventTypeName - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. readOnly: true example: cluster1 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 currentValue: "$ref": "#/components/schemas/TimeMetricValueView" eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnameAndPort: type: string 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. readOnly: true example: cloud-test.mongodb.com:27017 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" metricName: type: string description: |- Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see Host Metrics. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements. readOnly: true example: ASSERT_USER x-xgen-IPA-exception: xgen-IPA-117-description-must-not-use-html: Description predates IPA validation orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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. readOnly: true example: event-replica-set resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 AlertView: title: Alert required: - alertConfigId - created - id - status - updated type: object properties: acknowledgedUntil: type: string 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. format: date-time externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 acknowledgementComment: maxLength: 200 type: string description: Comment that a MongoDB Cloud user submitted when acknowledging the alert. example: Expiration on 3/19. Silencing for 7days. acknowledgingUsername: type: string 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 alertConfigId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 created: type: string description: Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastNotified: type: string 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. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. readOnly: true example: 32b6e34b3d91647abb20e7b8 resolved: type: string 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"`.' format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 status: type: string 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. readOnly: true example: OPEN enum: - CANCELLED - CLOSED - OPEN - TRACKING updated: type: string description: Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system. AlertMatcher: title: Matchers required: - fieldName - operator - value type: object properties: fieldName: type: string description: Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. operator: type: string description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX value: type: string description: Value to match or exceed using the specified **matchers.operator**. example: event-replica-set description: Rules to apply when comparing an target instance against this alert configuration. AlertsNotificationRootForGroup: type: object description: One target that MongoDB Cloud sends notifications when an alert triggers. x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/DatadogNotification" - "$ref": "#/components/schemas/EmailNotification" - "$ref": "#/components/schemas/GroupNotification" - "$ref": "#/components/schemas/HipChatNotification" - "$ref": "#/components/schemas/MicrosoftTeamsNotification" - "$ref": "#/components/schemas/OpsGenieNotification" - "$ref": "#/components/schemas/OrgNotification" - "$ref": "#/components/schemas/PagerDutyNotification" - "$ref": "#/components/schemas/SlackNotification" - "$ref": "#/components/schemas/SMSNotification" - "$ref": "#/components/schemas/TeamNotification" - "$ref": "#/components/schemas/UserNotification" - "$ref": "#/components/schemas/VictorOpsNotification" - "$ref": "#/components/schemas/WebhookNotification" AlertsThresholdInteger: title: Threshold type: object properties: operator: "$ref": "#/components/schemas/Operator" threshold: type: integer description: Value of metric that, when exceeded, triggers an alert. format: int32 units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion description: A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`. AppServiceAlertConfigViewForNdsGroup: title: App Services Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AppServiceMetricMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified. AppServiceEventTypeViewAlertableNoThreshold: title: App Services Event Types type: string description: Event type that triggers an alert. example: DEPLOYMENT_FAILURE 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 AppServiceEventTypeViewAlertableWithThreshold: title: App Services Event Types type: string description: Event type that triggers an alert. example: OUTSIDE_REALM_METRIC_THRESHOLD enum: - OUTSIDE_REALM_METRIC_THRESHOLD AppServiceMetricAlertConfigViewForNdsGroup: title: App Services Metric Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AppServiceMetricMatcher" metricThreshold: "$ref": "#/components/schemas/AppServiceMetricThreshold" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified. AppServiceMetricMatcher: title: Matchers required: - fieldName - operator - value type: object properties: fieldName: "$ref": "#/components/schemas/AppServiceMetricMatcherField" operator: type: string description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX value: type: string description: Value to match or exceed using the specified **matchers.operator**. example: event-replica-set description: Rules to apply when comparing an app service metric against this alert configuration. AppServiceMetricMatcherField: title: App Services Metric Matcher Fields type: string description: Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. example: APPLICATION_ID enum: - APPLICATION_ID AppServiceMetricThreshold: title: App Services Metric Threshold required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion 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: propertyName: metricName mapping: REALM_TRIGGERS_FAILED_REQUESTS: "#/components/schemas/RawMetricThresholdView" REALM_GQL_FAILED_REQUESTS: "#/components/schemas/RawMetricThresholdView" REALM_ENDPOINTS_FAILED_REQUESTS: "#/components/schemas/RawMetricThresholdView" REALM_SDKFNS_FAILED_REQUESTS: "#/components/schemas/RawMetricThresholdView" REALM_OVERALL_FAILED_REQUESTS: "#/components/schemas/RawMetricThresholdView" REALM_OVERALL_COMPUTE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_OVERALL_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_TRIGGERS_COMPUTE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_TRIGGERS_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_SYNC_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_SYNC_FAILED_REQUESTS: "#/components/schemas/DataMetricThresholdView" REALM_SYNC_SESSIONS_ENDED: "#/components/schemas/DataMetricThresholdView" REALM_SYNC_CLIENT_BOOTSTRAP_MS: "#/components/schemas/TimeMetricThresholdView" REALM_SYNC_CLIENT_READS_FAILED: "#/components/schemas/DataMetricThresholdView" REALM_SYNC_CLIENT_UPLOADS_FAILED: "#/components/schemas/DataMetricThresholdView" REALM_SYNC_CLIENT_CHANGESETS_INVALID: "#/components/schemas/DataMetricThresholdView" REALM_ENDPOINTS_COMPUTE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_ENDPOINTS_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_SDK_MQL_COMPUTE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_SDK_MQL_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_SDK_FUNCTIONS_COMPUTE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_SDK_FUNCTIONS_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_GQL_COMPUTE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_GQL_EGRESS_BYTES: "#/components/schemas/DataMetricThresholdView" REALM_AUTH_LOGIN_FAIL: "#/components/schemas/RawMetricThresholdView" REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM: "#/components/schemas/TimeMetricThresholdView" REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM: "#/components/schemas/TimeMetricThresholdView" REALM_GQL_RESPONSE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_ENDPOINTS_RESPONSE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_SDK_FNS_RESPONSE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_SDK_MQL_RESPONSE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_TRIGGERS_RESPONSE_MS: "#/components/schemas/TimeMetricThresholdView" REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT: "#/components/schemas/RawMetricThresholdView" AssertMsgRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" AssertRegularRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" AssertUserRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" AssertWarningRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" AvgCommandExecutionTimeTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" AvgReadExecutionTimeTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" AvgWriteExecutionTimeTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" BillingEventTypeViewAlertableWithThreshold: title: Billing Event Type type: string description: Event type that triggers an alert. example: PENDING_INVOICE_OVER_THRESHOLD enum: - PENDING_INVOICE_OVER_THRESHOLD - DAILY_BILL_OVER_THRESHOLD BillingThresholdAlertConfigViewForNdsGroup: title: Billing Threshold Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/GreaterThanRawThreshold" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified. CacheBytesReadIntoDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" CacheBytesWrittenFromDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" CacheUsageDirtyDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" CacheUsageUsedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" ClusterAlertConfigViewForNdsGroup: title: Cluster Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroupAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ClusterMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified. ClusterMatcher: title: Matchers required: - fieldName - operator - value type: object properties: fieldName: "$ref": "#/components/schemas/ClusterMatcherField" operator: type: string description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX value: type: string description: Value to match or exceed using the specified **matchers.operator**. example: event-replica-set description: Rules to apply when comparing an cluster against this alert configuration. ClusterMatcherField: title: Cluster Matcher Fields type: string description: Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. example: CLUSTER_NAME enum: - CLUSTER_NAME ComputedMemoryDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" ConnectionsMaxRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ConnectionsPercentRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ConnectionsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold: title: Cps Backup Event Type type: string description: Event type that triggers an alert. example: CPS_SNAPSHOT_BEHIND enum: - CPS_SNAPSHOT_BEHIND - CPS_PREV_SNAPSHOT_OLD - CPS_OPLOG_BEHIND CpsBackupThresholdAlertConfigViewForNdsGroup: title: Cps Backup Threshold Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/GreaterThanTimeThreshold" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 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. CursorsTotalClientCursorsSizeRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" CursorsTotalOpenRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" CursorsTotalTimedOutRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DLQRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" DatadogNotification: title: Datadog Notification required: - typeName type: object properties: datadogApiKey: type: string 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" datadogRegion: type: string description: 'Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `"notifications.[n].typeName" : "DATADOG"`.' externalDocs: description: Datadog regions url: https://docs.datadoghq.com/getting_started/site/ default: US enum: - US - EU - US3 - US5 - AP1 - US1_FED delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - DATADOG description: Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. DbDataSizeTotalDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" DbDataSizeTotalWoSystemDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" DbIndexSizeTotalDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" DbStorageTotalDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" DefaultAlertConfigViewForNdsGroup: title: Any Other Alert Configurations required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: type: object description: Incident that triggered this alert. oneOf: - title: Billing Event Types type: string enum: - CREDIT_CARD_ABOUT_TO_EXPIRE - title: Cps Backup 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_AUTO_EXPORT_FAILED - CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED - CPS_OPLOG_CAUGHT_UP - title: Data Protection 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: FTS Index Audit Types type: string enum: - FTS_INDEX_DELETION_FAILED - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED - FTS_INDEXES_SYNONYM_MAPPING_INVALID - title: Group Event Types type: string enum: - USERS_WITHOUT_MULTI_FACTOR_AUTH - ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED - ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID - title: NDS Audit 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: NDS Maintenance Window Audit Types type: string enum: - MAINTENANCE_IN_ADVANCED - MAINTENANCE_AUTO_DEFERRED - MAINTENANCE_STARTED - MAINTENANCE_NO_LONGER_NEEDED - title: Online Archive Event Types type: string enum: - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK - title: User Event Types type: string enum: - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT - title: Resource Event Types type: string enum: - TAGS_MODIFIED - CLUSTER_TAGS_MODIFIED - GROUP_TAGS_MODIFIED - title: Stream Processor Event Types type: string enum: - STREAM_PROCESSOR_STATE_IS_FAILED - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD - title: NDS Auto Scaling Audit 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 - title: Atlas Resource Policy Audit Types type: string enum: - RESOURCE_POLICY_VIOLATED groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Other alerts which don't have extra details beside of basic one. DiskPartitionQueueDepthDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionQueueDepthIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionQueueDepthJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionReadIopsDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionReadIopsIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionReadIopsJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionReadLatencyDataTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" DiskPartitionReadLatencyIndexTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" DiskPartitionReadLatencyJournalTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" DiskPartitionSpaceUsedDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionSpaceUsedIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionSpaceUsedJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionWriteIopsDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionWriteIopsIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionWriteIopsJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DiskPartitionWriteLatencyDataTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" DiskPartitionWriteLatencyIndexTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" DiskPartitionWriteLatencyJournalTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" DocumentDeletedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DocumentInsertedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DocumentReturnedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" DocumentUpdatedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" EmailNotification: title: Email Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 emailAddress: type: string 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 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - EMAIL description: Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. EncryptionKeyAlertConfigViewForNdsGroup: title: Encryption Key Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/EncryptionKeyEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/GreaterThanDaysThresholdView" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified. EncryptionKeyEventTypeViewAlertable: title: Encryption Event Types type: string description: Event type that triggers an alert. example: AWS_ENCRYPTION_KEY_NEEDS_ROTATION 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 EventSeverity: type: string description: Severity of the event. enum: - INFO - WARNING - ERROR - CRITICAL ExtraInfoPageFaultsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexAVGCommandExecutionTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" FlexAVGWriteExecutionTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" FlexClusterMetricThreshold: title: Flex Cluster Metric Threshold required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion 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: propertyName: metricName mapping: 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" FLEX_AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView" FLEX_AVG_WRITE_EXECUTION_TIME: "#/components/schemas/FlexAVGWriteExecutionTimeMetricThresholdView" FLEX_AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/FlexAVGCommandExecutionTimeMetricThresholdView" 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" FlexConnectionPercentRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexMetricAlertConfigViewForNdsGroup: title: Flex Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/FlexMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" metricThreshold: "$ref": "#/components/schemas/FlexClusterMetricThreshold" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Flex metric alert configuration allows to select which Flex database metrics trigger alerts and how users are notified. FlexMetricEventTypeViewAlertable: title: Flex Metric Event Types type: string description: Event type that triggers an alert. example: OUTSIDE_FLEX_METRIC_THRESHOLD enum: - OUTSIDE_FLEX_METRIC_THRESHOLD FlexNetworkBytesInDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FlexNetworkBytesOutDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FlexNetworkNumRequestsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexOpCounterCMDRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexOpCounterDeleteRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexOpCounterGetMoreRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexOpCounterInsertRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexOpCounterQueryRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FlexOpCounterUpdateRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FtsDiskUtilizationDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FtsJvmCurrentMemoryDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FtsJvmMaxMemoryDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FtsMemoryMappedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FtsMemoryResidentDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FtsMemoryVirtualDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" FtsProcessCpuKernelRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" FtsProcessCpuUserRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GlobalAccessesNotInMemoryRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GlobalLockCurrentQueueReadersRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GlobalLockCurrentQueueTotalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GlobalLockCurrentQueueWritersRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GlobalLockPercentageRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GlobalPageFaultExceptionsThrownRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" GreaterThanDaysThresholdView: type: object properties: operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - GREATER_THAN threshold: type: integer description: Value of metric that, when exceeded, triggers an alert. format: int32 units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - DAYS description: Threshold value that triggers an alert. GreaterThanRawThreshold: title: Greater Than Raw Threshold type: object properties: operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - GREATER_THAN threshold: type: integer description: Value of metric that, when exceeded, triggers an alert. format: int32 units: "$ref": "#/components/schemas/RawMetricUnits" description: A Limit that triggers an alert when greater than a number. GreaterThanRawThresholdAlertConfigViewForNdsGroup: required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ReplicaSetMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/GreaterThanRawThreshold" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 GreaterThanTimeThreshold: title: Greater Than Time Threshold type: object properties: operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - GREATER_THAN threshold: type: integer description: Value of metric that, when exceeded, triggers an alert. format: int32 units: "$ref": "#/components/schemas/TimeMetricUnits" description: A Limit that triggers an alert when greater than a time period. GroupAlertsConfig: type: object x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation 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/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" GroupNotification: title: Group Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 emailEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 roles: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: One or more project roles that receive the configured alert. enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER smsEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list typeName: type: string description: Human-readable label that displays the alert notification type. enum: - GROUP description: Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. HipChatNotification: title: HipChat Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notificationToken: type: string 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" notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 roomName: type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - HIP_CHAT description: HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. HostAlertConfigViewForNdsGroup: title: Host Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/HostMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Host alert configuration allows to select which mongod host events trigger alerts and how users are notified. HostMatcher: title: Matchers required: - fieldName - operator type: object properties: fieldName: "$ref": "#/components/schemas/HostMatcherField" operator: type: string description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX value: "$ref": "#/components/schemas/MatcherHostType" description: Rules to apply when comparing an host against this alert configuration. HostMatcherField: title: Host Matcher Fields type: string description: Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. example: HOSTNAME enum: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME HostMetricAlertConfigViewForNdsGroup: title: Host Metric Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/HostMatcher" metricThreshold: "$ref": "#/components/schemas/HostMetricThreshold" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified. HostMetricThreshold: title: Host Metric Threshold required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion 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: propertyName: metricName mapping: ASSERT_REGULAR: "#/components/schemas/AssertRegularRawMetricThresholdView" ASSERT_WARNING: "#/components/schemas/AssertWarningRawMetricThresholdView" ASSERT_MSG: "#/components/schemas/AssertMsgRawMetricThresholdView" ASSERT_USER: "#/components/schemas/AssertUserRawMetricThresholdView" OPCOUNTER_CMD: "#/components/schemas/OpCounterCmdRawMetricThresholdView" OPCOUNTER_QUERY: "#/components/schemas/OpCounterQueryRawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/OpCounterUpdateRawMetricThresholdView" OPCOUNTER_DELETE: "#/components/schemas/OpCounterDeleteRawMetricThresholdView" OPCOUNTER_TTL_DELETED: "#/components/schemas/OpCounterTtlDeletedRawMetricThresholdView" OPCOUNTER_INSERT: "#/components/schemas/OpCounterInsertRawMetricThresholdView" OPCOUNTER_GETMORE: "#/components/schemas/OpCounterGetMoreRawMetricThresholdView" OPCOUNTER_REPL_CMD: "#/components/schemas/OpCounterReplCmdRawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/OpCounterReplUpdateRawMetricThresholdView" OPCOUNTER_REPL_DELETE: "#/components/schemas/OpCounterReplDeleteRawMetricThresholdView" OPCOUNTER_REPL_INSERT: "#/components/schemas/OpCounterReplInsertRawMetricThresholdView" FTS_MEMORY_RESIDENT: "#/components/schemas/FtsMemoryResidentDataMetricThresholdView" FTS_MEMORY_VIRTUAL: "#/components/schemas/FtsMemoryVirtualDataMetricThresholdView" FTS_MEMORY_MAPPED: "#/components/schemas/FtsMemoryMappedDataMetricThresholdView" FTS_PROCESS_CPU_USER: "#/components/schemas/FtsProcessCpuUserRawMetricThresholdView" FTS_PROCESS_CPU_KERNEL: "#/components/schemas/FtsProcessCpuKernelRawMetricThresholdView" NORMALIZED_FTS_PROCESS_CPU_USER: "#/components/schemas/NormalizedFtsProcessCpuUserRawMetricThresholdView" NORMALIZED_FTS_PROCESS_CPU_KERNEL: "#/components/schemas/NormalizedFtsProcessCpuKernelRawMetricThresholdView" SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/SystemMemoryPercentUsedRawMetricThresholdView" MEMORY_RESIDENT: "#/components/schemas/MemoryResidentDataMetricThresholdView" MEMORY_VIRTUAL: "#/components/schemas/MemoryVirtualDataMetricThresholdView" MEMORY_MAPPED: "#/components/schemas/MemoryMappedDataMetricThresholdView" COMPUTED_MEMORY: "#/components/schemas/ComputedMemoryDataMetricThresholdView" 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" GLOBAL_LOCK_PERCENTAGE: "#/components/schemas/GlobalLockPercentageRawMetricThresholdView" BACKGROUND_FLUSH_AVG: "#/components/schemas/TimeMetricThresholdView" CONNECTIONS: "#/components/schemas/ConnectionsRawMetricThresholdView" CONNECTIONS_MAX: "#/components/schemas/ConnectionsMaxRawMetricThresholdView" CONNECTIONS_PERCENT: "#/components/schemas/ConnectionsPercentRawMetricThresholdView" GLOBAL_ACCESSES_NOT_IN_MEMORY: "#/components/schemas/GlobalAccessesNotInMemoryRawMetricThresholdView" GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: "#/components/schemas/GlobalPageFaultExceptionsThrownRawMetricThresholdView" GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: "#/components/schemas/GlobalLockCurrentQueueTotalRawMetricThresholdView" GLOBAL_LOCK_CURRENT_QUEUE_READERS: "#/components/schemas/GlobalLockCurrentQueueReadersRawMetricThresholdView" GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: "#/components/schemas/GlobalLockCurrentQueueWritersRawMetricThresholdView" CURSORS_TOTAL_OPEN: "#/components/schemas/CursorsTotalOpenRawMetricThresholdView" CURSORS_TOTAL_TIMED_OUT: "#/components/schemas/CursorsTotalTimedOutRawMetricThresholdView" CURSORS_TOTAL_CLIENT_CURSORS_SIZE: "#/components/schemas/CursorsTotalClientCursorsSizeRawMetricThresholdView" NETWORK_BYTES_IN: "#/components/schemas/NetworkBytesInDataMetricThresholdView" NETWORK_BYTES_OUT: "#/components/schemas/NetworkBytesOutDataMetricThresholdView" NETWORK_NUM_REQUESTS: "#/components/schemas/NetworkNumRequestsRawMetricThresholdView" OPLOG_MASTER_TIME: "#/components/schemas/OplogMasterTimeTimeMetricThresholdView" OPLOG_MASTER_TIME_ESTIMATED_TTL: "#/components/schemas/OplogMasterTimeEstimatedTtlTimeMetricThresholdView" OPLOG_SLAVE_LAG_MASTER_TIME: "#/components/schemas/OplogSlaveLagMasterTimeTimeMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/OplogMasterLagTimeDiffTimeMetricThresholdView" OPLOG_RATE_GB_PER_HOUR: "#/components/schemas/OplogRateGbPerHourDataMetricThresholdView" EXTRA_INFO_PAGE_FAULTS: "#/components/schemas/ExtraInfoPageFaultsRawMetricThresholdView" DB_STORAGE_TOTAL: "#/components/schemas/DbStorageTotalDataMetricThresholdView" DB_DATA_SIZE_TOTAL: "#/components/schemas/DbDataSizeTotalDataMetricThresholdView" DB_DATA_SIZE_TOTAL_WO_SYSTEM: "#/components/schemas/DbDataSizeTotalWoSystemDataMetricThresholdView" DB_INDEX_SIZE_TOTAL: "#/components/schemas/DbIndexSizeTotalDataMetricThresholdView" JOURNALING_COMMITS_IN_WRITE_LOCK: "#/components/schemas/JournalingCommitsInWriteLockRawMetricThresholdView" JOURNALING_MB: "#/components/schemas/JournalingMbDataMetricThresholdView" JOURNALING_WRITE_DATA_FILES_MB: "#/components/schemas/JournalingWriteDataFilesMbDataMetricThresholdView" TICKETS_AVAILABLE_READS: "#/components/schemas/TicketsAvailableReadsRawMetricThresholdView" TICKETS_AVAILABLE_WRITES: "#/components/schemas/TicketsAvailableWritesRawMetricThresholdView" CACHE_USAGE_DIRTY: "#/components/schemas/CacheUsageDirtyDataMetricThresholdView" CACHE_USAGE_USED: "#/components/schemas/CacheUsageUsedDataMetricThresholdView" CACHE_BYTES_READ_INTO: "#/components/schemas/CacheBytesReadIntoDataMetricThresholdView" CACHE_BYTES_WRITTEN_FROM: "#/components/schemas/CacheBytesWrittenFromDataMetricThresholdView" NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/NormalizedSystemCpuUserRawMetricThresholdView" NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/NormalizedSystemCpuStealRawMetricThresholdView" 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_READ_IOPS_DATA: "#/components/schemas/DiskPartitionReadIopsDataRawMetricThresholdView" DISK_PARTITION_READ_IOPS_INDEX: "#/components/schemas/DiskPartitionReadIopsIndexRawMetricThresholdView" DISK_PARTITION_READ_IOPS_JOURNAL: "#/components/schemas/DiskPartitionReadIopsJournalRawMetricThresholdView" 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_READ_LATENCY_DATA: "#/components/schemas/DiskPartitionReadLatencyDataTimeMetricThresholdView" DISK_PARTITION_READ_LATENCY_INDEX: "#/components/schemas/DiskPartitionReadLatencyIndexTimeMetricThresholdView" DISK_PARTITION_READ_LATENCY_JOURNAL: "#/components/schemas/DiskPartitionReadLatencyJournalTimeMetricThresholdView" DISK_PARTITION_WRITE_LATENCY_DATA: "#/components/schemas/DiskPartitionWriteLatencyDataTimeMetricThresholdView" DISK_PARTITION_WRITE_LATENCY_INDEX: "#/components/schemas/DiskPartitionWriteLatencyIndexTimeMetricThresholdView" DISK_PARTITION_WRITE_LATENCY_JOURNAL: "#/components/schemas/DiskPartitionWriteLatencyJournalTimeMetricThresholdView" DISK_PARTITION_QUEUE_DEPTH_DATA: "#/components/schemas/DiskPartitionQueueDepthDataRawMetricThresholdView" DISK_PARTITION_QUEUE_DEPTH_INDEX: "#/components/schemas/DiskPartitionQueueDepthIndexRawMetricThresholdView" DISK_PARTITION_QUEUE_DEPTH_JOURNAL: "#/components/schemas/DiskPartitionQueueDepthJournalRawMetricThresholdView" FTS_DISK_UTILIZATION: "#/components/schemas/FtsDiskUtilizationDataMetricThresholdView" MUNIN_CPU_USER: "#/components/schemas/MuninCpuUserRawMetricThresholdView" MUNIN_CPU_NICE: "#/components/schemas/MuninCpuNiceRawMetricThresholdView" MUNIN_CPU_SYSTEM: "#/components/schemas/MuninCpuSystemRawMetricThresholdView" MUNIN_CPU_IOWAIT: "#/components/schemas/MuninCpuIowaitRawMetricThresholdView" MUNIN_CPU_IRQ: "#/components/schemas/MuninCpuIrqRawMetricThresholdView" MUNIN_CPU_SOFTIRQ: "#/components/schemas/MuninCpuSoftirqRawMetricThresholdView" MUNIN_CPU_STEAL: "#/components/schemas/MuninCpuStealRawMetricThresholdView" DOCUMENT_RETURNED: "#/components/schemas/DocumentReturnedRawMetricThresholdView" DOCUMENT_INSERTED: "#/components/schemas/DocumentInsertedRawMetricThresholdView" DOCUMENT_UPDATED: "#/components/schemas/DocumentUpdatedRawMetricThresholdView" DOCUMENT_DELETED: "#/components/schemas/DocumentDeletedRawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/OperationsScanAndOrderRawMetricThresholdView" QUERY_EXECUTOR_SCANNED: "#/components/schemas/QueryExecutorScannedRawMetricThresholdView" QUERY_EXECUTOR_SCANNED_OBJECTS: "#/components/schemas/QueryExecutorScannedObjectsRawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/OperationThrottlingRejectedOperationsRawMetricThresholdView" QUERY_SPILL_TO_DISK_DURING_SORT: "#/components/schemas/QuerySpillToDiskDuringSortRawMetricThresholdView" OPERATIONS_QUERIES_KILLED: "#/components/schemas/OperationsQueriesKilledRawMetricThresholdView" QUERY_TARGETING_SCANNED_PER_RETURNED: "#/components/schemas/QueryTargetingScannedPerReturnedRawMetricThresholdView" QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: "#/components/schemas/QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView" AVG_READ_EXECUTION_TIME: "#/components/schemas/AvgReadExecutionTimeTimeMetricThresholdView" AVG_WRITE_EXECUTION_TIME: "#/components/schemas/AvgWriteExecutionTimeTimeMetricThresholdView" AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/AvgCommandExecutionTimeTimeMetricThresholdView" LOGICAL_SIZE: "#/components/schemas/LogicalSizeDataMetricThresholdView" RESTARTS_IN_LAST_HOUR: "#/components/schemas/RestartsInLastHourRawMetricThresholdView" SYSTEM_MEMORY_USED: "#/components/schemas/SystemMemoryUsedDataMetricThresholdView" SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/SystemMemoryAvailableDataMetricThresholdView" SWAP_USAGE_USED: "#/components/schemas/SwapUsageUsedDataMetricThresholdView" SWAP_USAGE_FREE: "#/components/schemas/SwapUsageFreeDataMetricThresholdView" SYSTEM_NETWORK_IN: "#/components/schemas/SystemNetworkInDataMetricThresholdView" SYSTEM_NETWORK_OUT: "#/components/schemas/SystemNetworkOutDataMetricThresholdView" MAX_NORMALIZED_SYSTEM_CPU_USER: "#/components/schemas/MaxNormalizedSystemCpuUserRawMetricThresholdView" MAX_NORMALIZED_SYSTEM_CPU_STEAL: "#/components/schemas/MaxNormalizedSystemCpuStealRawMetricThresholdView" 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_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_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_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_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_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_SYSTEM_MEMORY_PERCENT_USED: "#/components/schemas/MaxSystemMemoryPercentUsedRawMetricThresholdView" MAX_SYSTEM_MEMORY_USED: "#/components/schemas/MaxSystemMemoryUsedDataMetricThresholdView" MAX_SYSTEM_MEMORY_AVAILABLE: "#/components/schemas/MaxSystemMemoryAvailableDataMetricThresholdView" MAX_SWAP_USAGE_USED: "#/components/schemas/MaxSwapUsageUsedDataMetricThresholdView" MAX_SWAP_USAGE_FREE: "#/components/schemas/MaxSwapUsageFreeDataMetricThresholdView" MAX_SYSTEM_NETWORK_IN: "#/components/schemas/MaxSystemNetworkInDataMetricThresholdView" MAX_SYSTEM_NETWORK_OUT: "#/components/schemas/MaxSystemNetworkOutDataMetricThresholdView" SEARCH_INDEX_SIZE: "#/components/schemas/SearchIndexSizeDataMetricThresholdView" SEARCH_NUMBER_OF_FIELDS_IN_INDEX: "#/components/schemas/SearchNumberOfFieldsInIndexRawMetricThresholdView" SEARCH_REPLICATION_LAG: "#/components/schemas/SearchReplicationLagTimeMetricThresholdView" SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: "#/components/schemas/NumberMetricThresholdView" SEARCH_OPCOUNTER_INSERT: "#/components/schemas/SearchOpCounterInsertRawMetricThresholdView" SEARCH_OPCOUNTER_DELETE: "#/components/schemas/SearchOpCounterDeleteRawMetricThresholdView" SEARCH_OPCOUNTER_UPDATE: "#/components/schemas/SearchOpCounterUpdateRawMetricThresholdView" SEARCH_OPCOUNTER_GETMORE: "#/components/schemas/SearchOpCounterGetMoreRawMetricThresholdView" SEARCH_NUMBER_OF_QUERIES_TOTAL: "#/components/schemas/SearchNumberOfQueriesTotalRawMetricThresholdView" SEARCH_NUMBER_OF_QUERIES_ERROR: "#/components/schemas/SearchNumberOfQueriesErrorRawMetricThresholdView" SEARCH_NUMBER_OF_QUERIES_SUCCESS: "#/components/schemas/SearchNumberOfQueriesSuccessRawMetricThresholdView" FTS_JVM_MAX_MEMORY: "#/components/schemas/FtsJvmMaxMemoryDataMetricThresholdView" FTS_JVM_CURRENT_MEMORY: "#/components/schemas/FtsJvmCurrentMemoryDataMetricThresholdView" 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/SearchNumberOfFieldsInIndexRawMetricThresholdView" - "$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" IndexCountersBtreeAccessesRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" IndexCountersBtreeHitsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" IndexCountersBtreeMissRatioRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" IndexCountersBtreeMissesRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" JournalingCommitsInWriteLockRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" JournalingMbDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" JournalingWriteDataFilesMbDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" KafkaRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" LessThanDaysThresholdView: type: object properties: operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN threshold: type: integer description: Value of metric that, when exceeded, triggers an alert. format: int32 units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - DAYS description: Threshold value that triggers an alert. LessThanTimeThreshold: title: Less Than Time Threshold type: object properties: operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN threshold: type: integer description: Value of metric that, when exceeded, triggers an alert. format: int32 units: "$ref": "#/components/schemas/TimeMetricUnits" description: A Limit that triggers an alert when less than a time period. LessThanTimeThresholdAlertConfigViewForNdsGroup: required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ReplicaSetMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/LessThanTimeThreshold" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 LogicalSizeDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MatcherHostType: title: Matcher Host Types type: string description: Value to match or exceed using the specified **matchers.operator**. example: STANDALONE enum: - STANDALONE - PRIMARY - SECONDARY - ARBITER - MONGOS - CONFIG - MONGOT MaxDiskPartitionQueueDepthDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionQueueDepthIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionQueueDepthJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionReadIopsDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionReadIopsIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionReadIopsJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionReadLatencyDataTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" MaxDiskPartitionSpaceUsedDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionWriteIopsDataRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionWriteIopsIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionWriteIopsJournalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" MaxNormalizedSystemCpuStealRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxNormalizedSystemCpuUserRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxSwapUsageFreeDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MaxSwapUsageUsedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MaxSystemMemoryAvailableDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MaxSystemMemoryPercentUsedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MaxSystemMemoryUsedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MaxSystemNetworkInDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MaxSystemNetworkOutDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MemoryMappedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MemoryResidentDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MemoryVirtualDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" MicrosoftTeamsNotification: title: Microsoft Teams Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 microsoftTeamsWebhookUrl: type: string 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/**** notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - MICROSOFT_TEAMS description: Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. MuninCpuIowaitRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MuninCpuIrqRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MuninCpuNiceRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MuninCpuSoftirqRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MuninCpuStealRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MuninCpuSystemRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" MuninCpuUserRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" NDSX509UserAuthenticationAlertConfigViewForNdsGroup: title: NDS X509 User Authentication Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/LessThanDaysThresholdView" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: NDS 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. NDSX509UserAuthenticationEventTypeViewAlertable: title: NDS x509 User Auth Event Types type: string description: Event type that triggers an alert. example: NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK 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 NetworkBytesInDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" NetworkBytesOutDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" NetworkNumRequestsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" NormalizedFtsProcessCpuKernelRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" NormalizedFtsProcessCpuUserRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" NormalizedSystemCpuStealRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" NormalizedSystemCpuUserRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" NumberMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/NumberMetricUnits" OpCounterCmdRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterDeleteRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterGetMoreRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterInsertRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterQueryRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterReplCmdRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterReplDeleteRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterReplInsertRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterReplUpdateRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterTtlDeletedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OpCounterUpdateRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OperationThrottlingRejectedOperationsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OperationsQueriesKilledRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" OperationsScanAndOrderRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" Operator: type: string description: Comparison operator to apply when checking the current metric value. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - "<" - ">" OplogMasterLagTimeDiffTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" OplogMasterTimeEstimatedTtlTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" OplogMasterTimeTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" OplogRateGbPerHourDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" OplogSlaveLagMasterTimeTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" OpsGenieNotification: title: OpsGenie Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 opsGenieApiKey: type: string 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" opsGenieRegion: type: string description: Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. default: US enum: - US - EU typeName: type: string description: Human-readable label that displays the alert notification type. enum: - OPS_GENIE description: OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. OrgNotification: title: Org Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 emailEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 roles: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string 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 smsEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list typeName: type: string description: Human-readable label that displays the alert notification type. enum: - ORG description: Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. PagerDutyNotification: title: PagerDuty Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 region: type: string description: PagerDuty region that indicates which API Uniform Resource Locator (URL) to use. default: US enum: - US - EU serviceKey: type: string 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" typeName: type: string description: Human-readable label that displays the alert notification type. enum: - PAGER_DUTY description: PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. PaginatedAlertConfigView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/GroupAlertsConfig" totalCount: minimum: 0 type: integer 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 readOnly: true QueryExecutorScannedObjectsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" QueryExecutorScannedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" QuerySpillToDiskDuringSortRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" QueryTargetingScannedPerReturnedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" RPUMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/ServerlessMetricUnits" RawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ReplicaSetAlertConfigViewForNdsGroup: title: Replica Set Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ReplicaSetMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/AlertsThresholdInteger" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified. ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold: title: ReplicaSet Event Types type: string description: Event type that triggers an alert. example: NO_PRIMARY enum: - NO_PRIMARY - PRIMARY_ELECTED ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold: title: ReplicaSet Event Types type: string description: Event type that triggers an alert. example: TOO_MANY_ELECTIONS enum: - TOO_MANY_ELECTIONS - REPLICATION_OPLOG_WINDOW_RUNNING_OUT - TOO_FEW_HEALTHY_MEMBERS - TOO_MANY_UNHEALTHY_MEMBERS ReplicaSetMatcher: title: Matchers required: - fieldName - operator - value type: object properties: fieldName: "$ref": "#/components/schemas/ReplicaSetMatcherField" operator: type: string description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX value: type: string description: Value to match or exceed using the specified **matchers.operator**. example: event-replica-set description: Rules to apply when comparing an replica set against this alert configuration. ReplicaSetMatcherField: title: Replica Set Matcher Fields type: string description: Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. example: REPLICA_SET_NAME enum: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME ReplicaSetThresholdAlertConfigViewForNdsGroup: title: Replica Set Threshold Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ReplicaSetMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/AlertsThresholdInteger" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 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: propertyName: eventTypeName mapping: TOO_MANY_ELECTIONS: "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" REPLICATION_OPLOG_WINDOW_RUNNING_OUT: "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup" RestartsInLastHourRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SMSNotification: title: SMS Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 intervalMin: minimum: 5 type: integer 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 mobileNumber: type: string description: 'Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `"notifications.[n].typeName" : "SMS"`.' example: '1233337892' notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - SMS description: SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. SearchIndexSizeDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" SearchNumberOfFieldsInIndexRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchNumberOfQueriesErrorRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchNumberOfQueriesSuccessRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchNumberOfQueriesTotalRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchOpCounterDeleteRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchOpCounterGetMoreRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchOpCounterInsertRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchOpCounterUpdateRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SearchReplicationLagTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" ServerlessAVGCommandExecutionTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" ServerlessAVGWriteExecutionTimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" ServerlessConnectionPercentageRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessEventTypeViewAlertable: title: Serverless Event Types type: string description: Event type that triggers an alert. example: OUTSIDE_SERVERLESS_METRIC_THRESHOLD enum: - OUTSIDE_SERVERLESS_METRIC_THRESHOLD ServerlessMetricAlertConfigViewForNdsGroup: title: Serverless Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/ServerlessEventTypeViewAlertable" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" metricThreshold: "$ref": "#/components/schemas/ServerlessMetricThreshold" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified. ServerlessMetricThreshold: title: Serverless Metric Threshold required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion 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: propertyName: metricName mapping: 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" SERVERLESS_AVG_READ_EXECUTION_TIME: "#/components/schemas/TimeMetricThresholdView" SERVERLESS_AVG_WRITE_EXECUTION_TIME: "#/components/schemas/ServerlessAVGWriteExecutionTimeMetricThresholdView" SERVERLESS_AVG_COMMAND_EXECUTION_TIME: "#/components/schemas/ServerlessAVGCommandExecutionTimeMetricThresholdView" 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" ServerlessMetricUnits: title: Serverless Metric Units type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. example: RPU enum: - RPU - THOUSAND_RPU - MILLION_RPU - WPU - THOUSAND_WPU - MILLION_WPU ServerlessNetworkBytesInDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" ServerlessNetworkBytesOutDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" ServerlessNetworkNumRequestRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessOpCounterCDMRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessOpCounterDeleteRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessOpCounterGetMoreRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessOpCounterInsertRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessOpCounterQueryRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessOpCounterUpdateRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" ServerlessTotalWriteUnitsRPUMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/ServerlessMetricUnits" SlackNotification: title: Slack Notification required: - typeName type: object properties: apiToken: type: string 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" channelName: type: string 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 delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - SLACK description: Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. StreamProcessorAlertConfigViewForNdsGroup: title: Stream Processor Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/StreamProcessorEventTypeViewAlertableNoThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/StreamsMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified. StreamProcessorEventTypeViewAlertableNoThreshold: title: Stream Processor Event Types type: string description: Event type that triggers an alert. example: STREAM_PROCESSOR_STATE_IS_FAILED enum: - STREAM_PROCESSOR_STATE_IS_FAILED StreamProcessorEventTypeViewAlertableWithThreshold: title: Stream Processor Event Types type: string description: Event type that triggers an alert. example: OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD enum: - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD StreamProcessorMetricAlertConfigViewForNdsGroup: title: Stream Processor Metric Alert Configuration required: - eventTypeName - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: "$ref": "#/components/schemas/StreamProcessorEventTypeViewAlertableWithThreshold" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/StreamsMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationRootForGroup" severityOverride: "$ref": "#/components/schemas/EventSeverity" threshold: "$ref": "#/components/schemas/StreamProcessorMetricThreshold" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Stream Processor threshold alert configuration allows to select thresholds on metrics which trigger alerts and how users are notified. StreamProcessorMetricThreshold: title: Stream Processor Metric Threshold required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: type: string description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - bits - Kbits - Mbits - Gbits - bytes - KB - MB - GB - TB - PB - nsec - msec - sec - min - hours - million minutes - days - requests - 1000 requests - GB seconds - GB hours - GB days - RPU - thousand RPU - million RPU - WPU - thousand WPU - million WPU - count - thousand - million - billion 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: propertyName: metricName mapping: STREAM_PROCESSOR_KAFKA_LAG: "#/components/schemas/KafkaRawMetricThresholdView" STREAM_PROCESSOR_CHANGE_STREAM_LAG: "#/components/schemas/TimeMetricThresholdView" STREAM_PROCESSOR_DLQ_MESSAGE_COUNT: "#/components/schemas/DLQRawMetricThresholdView" STREAM_PROCESSOR_OUTPUT_MESSAGE_COUNT: "#/components/schemas/RawMetricThresholdView" oneOf: - "$ref": "#/components/schemas/KafkaRawMetricThresholdView" - "$ref": "#/components/schemas/TimeMetricThresholdView" - "$ref": "#/components/schemas/DLQRawMetricThresholdView" - "$ref": "#/components/schemas/RawMetricThresholdView" StreamsMatcher: title: Matchers required: - fieldName - operator - value type: object properties: fieldName: "$ref": "#/components/schemas/StreamsMatcherField" operator: type: string description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX value: type: string description: Value to match or exceed using the specified **matchers.operator**. example: event-replica-set description: Rules to apply when comparing a stream processing instance or stream processor against this alert configuration. StreamsMatcherField: title: Streams Matcher Fields type: string description: Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations. example: INSTANCE_NAME enum: - INSTANCE_NAME - PROCESSOR_NAME SwapUsageFreeDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" SwapUsageUsedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" SystemMemoryAvailableDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" SystemMemoryPercentUsedRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" SystemMemoryUsedDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" SystemNetworkInDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" SystemNetworkOutDataMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/DataMetricUnits" TeamNotification: title: Team Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 emailEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 smsEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list teamId: pattern: "^([a-f0-9]{24})$" type: string description: 'Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `"notifications.[n].typeName" : "TEAM"`.' example: 32b6e34b3d91647abb20e7b8 teamName: type: string description: 'Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `"notifications.[n].typeName" : "TEAM"`.' example: Atlas typeName: type: string description: Human-readable label that displays the alert notification type. enum: - TEAM description: Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. TicketsAvailableReadsRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" TicketsAvailableWritesRawMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/RawMetricUnits" TimeMetricThresholdView: required: - metricName type: object properties: metricName: type: string description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. mode: type: string description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE operator: type: string description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN threshold: type: number description: Value of metric that, when exceeded, triggers an alert. format: double units: "$ref": "#/components/schemas/TimeMetricUnits" UserNotification: title: User Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 emailEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 smsEnabled: type: boolean 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"` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list typeName: type: string description: Human-readable label that displays the alert notification type. enum: - USER username: type: string 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 description: User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. VictorOpsNotification: title: VictorOps Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - VICTOR_OPS victorOpsApiKey: type: string 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" victorOpsRoutingKey: type: string 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 description: VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. WebhookNotification: title: Webhook Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 integrationId: type: string description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - WEBHOOK webhookSecret: type: string 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 webhookSecret either on the Integrations page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted. format: password externalDocs: description: Integrations page url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one webhookUrl: type: string 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 webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted. example: https://webhook.com/**** x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one description: Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. MatcherFieldView: type: object oneOf: - title: App Services Metric Matcher Fields type: string enum: - APPLICATION_ID - title: Cluster Matcher Fields type: string enum: - CLUSTER_NAME - title: Host Matcher Fields type: string enum: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME - title: Replica Set Matcher Fields type: string enum: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME - title: Streams Matcher Fields type: string enum: - INSTANCE_NAME - PROCESSOR_NAME - title: Log Ingestion Matcher Fields type: string enum: - RULE_ID AlertConfigView: title: Alert Configuration required: - notifications type: object properties: created: type: string description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 enabled: type: boolean description: Flag that indicates whether someone enabled this alert configuration for the specified project. default: false eventTypeName: type: string description: Event type name. groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this alert configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" matchers: type: array description: Matching conditions for target resources. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertMatcher" notifications: type: array description: List that contains the targets that MongoDB Cloud sends notifications. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AlertsNotificationBase" severityOverride: "$ref": "#/components/schemas/EventSeverity" updated: type: string description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 description: Alert settings allows to select which conditions trigger alerts and how users are notified. AlertsNotificationBase: type: object description: One target that MongoDB Cloud sends notifications when an alert triggers. x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/DatadogNotification" - "$ref": "#/components/schemas/EmailNotification" - "$ref": "#/components/schemas/GroupNotification" - "$ref": "#/components/schemas/HipChatNotification" - "$ref": "#/components/schemas/MicrosoftTeamsNotification" - "$ref": "#/components/schemas/NDSNotificationView" - "$ref": "#/components/schemas/OpsGenieNotification" - "$ref": "#/components/schemas/OrgNotification" - "$ref": "#/components/schemas/PagerDutyNotification" - "$ref": "#/components/schemas/SlackNotification" - "$ref": "#/components/schemas/SMSNotification" - "$ref": "#/components/schemas/SummaryNotification" - "$ref": "#/components/schemas/TeamNotification" - "$ref": "#/components/schemas/UserNotification" - "$ref": "#/components/schemas/VictorOpsNotification" - "$ref": "#/components/schemas/WebhookNotification" NDSNotificationView: title: NDS Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 severity: type: string description: Degree of seriousness given to this notification. enum: - CRITICAL - ERROR - WARNING typeName: type: string description: Human-readable label that displays the alert notification type. enum: - NDS description: NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. SummaryNotification: title: Summary Notification required: - typeName type: object properties: delayMin: type: integer description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 emailAddress: type: string 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 intervalMin: minimum: 5 type: integer 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 notifierId: pattern: "^([a-f0-9]{24})$" type: string 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 typeName: type: string description: Human-readable label that displays the alert notification type. enum: - SUMMARY description: Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. AlertsToggle: title: Toggle Request type: object properties: enabled: type: boolean description: Flag that indicates whether to enable or disable the specified alert configuration in the specified project. description: Enables or disables the specified alert configuration in the specified project. AccessListItemView: required: - ipAddress type: object properties: cidrBlock: 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 description: Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list. readOnly: true ipAddress: 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: IP address included in the API access list. readOnly: true ApiKey: required: - id - publicKey type: object properties: accessList: type: array description: List of network addresses granted access to this API using this API key. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AccessListItemView" id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this organization API key. readOnly: true example: 32b6e34b3d91647abb20e7b8 publicKey: maxLength: 8 minLength: 8 type: string description: Public API key value set for the specified organization API key. readOnly: true roles: type: array description: List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudAccessRoleAssignment" description: Details contained in one API key. nullable: true readOnly: true CloudAccessRoleAssignment: title: Role Assignment type: object properties: groupId: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request. example: 32b6e34b3d91647abb20e7b8 orgId: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request. example: 32b6e34b3d91647abb20e7b8 roleName: type: string description: Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. enum: - ORG_MEMBER - ORG_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_CLUSTER_MANAGER - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER - GROUP_BACKUP_MANAGER - GROUP_OBSERVABILITY_VIEWER - GROUP_DATABASE_ACCESS_ADMIN 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. SystemStatus: required: - apiKey - appName - build - throttling type: object properties: apiKey: "$ref": "#/components/schemas/ApiKey" appName: type: string description: Human-readable label that identifies the service from which you requested this response. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - MongoDB Atlas build: type: string description: Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application. readOnly: true example: 83be55e140f493c88e7f578aae96548dd881587b links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" throttling: type: boolean description: Flag that indicates whether someone enabled throttling on this service. readOnly: true ApiError: required: - error - errorCode type: object properties: badRequestDetail: "$ref": "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each type of error. error: type: integer description: HTTP status code returned with this error. format: int32 readOnly: true externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status errorCode: type: string description: Application error code returned with this error. readOnly: true parameters: type: array description: Parameters used to give more information about the error. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: object readOnly: true reason: type: string description: Application error message returned with this error. readOnly: true BadRequestDetail: type: object properties: fields: type: array description: Describes all violations in a client request. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/FieldViolation" description: Bad request detail. readOnly: true FieldViolation: required: - description - field type: object properties: description: type: string description: A description of why the request element is bad. field: type: string description: A path that leads to a field in the request body. CloudCluster: type: object properties: alertCount: type: integer description: Whole number that indicates the quantity of alerts open on the cluster. format: int32 readOnly: true authEnabled: type: boolean description: Flag that indicates whether authentication is required to access the nodes in this cluster. readOnly: true availability: type: string description: Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - available - dead - unavailable - warning backupEnabled: type: boolean description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. readOnly: true clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments. readOnly: true dataSizeBytes: type: integer description: Total size of the data stored on each node in the cluster. The resource expresses this value in bytes. format: int64 readOnly: true name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster. readOnly: true nodeCount: type: integer description: Whole number that indicates the quantity of nodes that comprise the cluster. format: int32 readOnly: true sslEnabled: type: boolean description: Flag that indicates whether TLS authentication is required to access the nodes in this cluster. readOnly: true type: type: string description: Human-readable label that indicates the cluster type. readOnly: true enum: - REPLICA_SET - SHARDED_CLUSTER versions: uniqueItems: true type: array description: List that contains the versions of MongoDB that each node in the cluster runs. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Settings that describe the clusters in each project that the API key is authorized to view. readOnly: true OrgGroup: type: object properties: clusters: type: array description: Settings that describe the clusters in each project that the API key is authorized to view. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudCluster" groupId: type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true groupName: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the project. orgId: type: string description: Unique 24-hexadecimal character string that identifies the organization that contains the project. readOnly: true orgName: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the organization that contains the project. planType: type: string description: Human-readable label that indicates the plan type. readOnly: true tags: type: array description: List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string readOnly: true PaginatedOrgGroupView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/OrgGroup" totalCount: minimum: 0 type: integer 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 readOnly: true ApiKeyUserDetails: type: object properties: desc: maxLength: 250 minLength: 1 type: string description: Purpose or explanation provided when someone created this organization API key. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" privateKey: type: string description: Redacted private key returned for this organization API key. This key displays unredacted when first created. readOnly: true example: 55c3bbb6-b4bb-0be1-e66d20841f3e publicKey: maxLength: 8 minLength: 8 type: string description: Public API key value set for the specified organization API key. readOnly: true example: zmmrboas roles: type: array description: List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudAccessRoleAssignment" description: Details of the Programmatic API Keys. AtlasOrganization: required: - name type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization. readOnly: true example: 32b6e34b3d91647abb20e7b8 isDeleted: type: boolean description: Flag that indicates whether this organization has been deleted. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" name: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the organization. skipDefaultAlertsSettings: type: boolean description: Disables automatic alert creation. When set to true, no organization level alerts will be created automatically. default: false description: Details that describe the organization. CreateOrganizationResponse: type: object properties: apiKey: "$ref": "#/components/schemas/ApiKeyUserDetails" federationSettingsId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to. readOnly: true example: 32b6e34b3d91647abb20e7b8 orgOwnerId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization. readOnly: true example: 32b6e34b3d91647abb20e7b8 organization: "$ref": "#/components/schemas/AtlasOrganization" serviceAccount: "$ref": "#/components/schemas/OrgServiceAccount" skipDefaultAlertsSettings: type: boolean description: Disables automatic alert creation. When set to true, no organization level alerts will be created automatically. default: false OrgServiceAccount: type: object properties: clientId: pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" type: string description: The Client ID of the Service Account. example: mdb_sa_id_1234567890abcdef12345678 createdAt: type: string 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 description: type: string description: Human readable description for the Service Account. name: type: string description: Human-readable name for the Service Account. roles: uniqueItems: true type: array description: A list of Organization roles associated with the Service Account. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string 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 secrets: uniqueItems: true type: array description: A list of secrets associated with the specified Service Account. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ServiceAccountSecret" description: Organization Service Account that Atlas created for the organization. readOnly: true ServiceAccountSecret: required: - createdAt - expiresAt - id type: object properties: createdAt: type: string 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 expiresAt: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the secret. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastUsedAt: type: string 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 maskedSecretValue: type: string description: The masked Service Account secret. readOnly: true example: mdb_sa_sk_... secret: type: string description: The secret for the Service Account. It will be returned only the first time after creation. readOnly: true example: mdb_sa_sk_... CreateAtlasOrganizationApiKey: required: - desc - roles type: object properties: desc: maxLength: 250 minLength: 1 type: string description: Purpose or explanation provided when someone created this organization API key. roles: minItems: 1 type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY description: Details of the programmatic API key to be created. CreateOrganizationRequest: required: - name type: object properties: apiKey: "$ref": "#/components/schemas/CreateAtlasOrganizationApiKey" federationSettingsId: pattern: "^([a-f0-9]{24})$" type: string 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 name: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the organization. orgOwnerId: pattern: "^([a-f0-9]{24})$" type: string 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 serviceAccount: "$ref": "#/components/schemas/OrgServiceAccountRequest" skipDefaultAlertsSettings: type: boolean description: Disables automatic alert creation. When set to true, no organization level alerts will be created automatically. default: false OrgServiceAccountRequest: required: - description - name - roles - secretExpiresAfterHours type: object properties: description: maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" type: string description: Human readable description for the Service Account. name: maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" type: string description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. roles: minItems: 1 type: array description: A list of organization-level roles for the Service Account. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string 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 secretExpiresAfterHours: type: integer 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. format: int32 example: 8 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. CloudAppUser: required: - country - emailAddress - firstName - lastName - mobileNumber - password - username type: object properties: country: pattern: "^([A-Z]{2})$" type: string description: Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format. createdAt: type: string 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 emailAddress: type: string description: Email address that belongs to the MongoDB Cloud user. format: email readOnly: true deprecated: true firstName: type: string description: First or given name that belongs to the MongoDB Cloud user. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastAuth: type: string 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 lastName: type: string description: Last name, family name, or surname that belongs to the MongoDB Cloud user. links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mobileNumber: 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 description: Mobile phone number that belongs to the MongoDB Cloud user. password: minLength: 8 type: string description: Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console. format: password roles: type: array description: List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudAccessRoleAssignment" teamIds: uniqueItems: true type: array description: List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs. example: 32b6e34b3d91647abb20e7b8 username: type: string description: Email address that represents the username of the MongoDB Cloud user. format: email PaginatedApiAppUserView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/CloudAppUser" totalCount: minimum: 0 type: integer 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 readOnly: true AddUserToTeam: required: - id type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. example: 32b6e34b3d91647abb20e7b8 Team: required: - name - usernames type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this team. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" name: type: string description: Human-readable label that identifies the team. usernames: uniqueItems: true type: array description: List that contains the MongoDB Cloud users in this team. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string format: email TeamResponse: type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this team. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" name: type: string description: Human-readable label that identifies the team. PaginatedTeamView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/TeamResponse" totalCount: minimum: 0 type: integer 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 readOnly: true TeamUpdate: required: - name type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" name: type: string description: Human-readable label that identifies the team. writeOnly: true PaginatedOrganizationView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/AtlasOrganization" totalCount: minimum: 0 type: integer 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 readOnly: true OrgFederationSettings: title: Organization Federation Settings type: object properties: federatedDomains: uniqueItems: true type: array description: List of domains associated with the organization's identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string hasRoleMappings: type: boolean description: Flag that indicates whether this organization has role mappings configured. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this federation. readOnly: true example: 32b6e34b3d91647abb20e7b8 identityProviderId: pattern: "^([a-f0-9]{20})$" type: string description: Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization. example: c2777a9eca931f29fc2f identityProviderStatus: type: string description: String enum that indicates whether the identity provider is active. enum: - ACTIVE - INACTIVE description: Details that define how to connect one MongoDB Cloud organization to one federated authentication service. Group: required: - clusterCount - created - name - orgId type: object properties: clusterCount: type: integer description: Quantity of MongoDB Cloud clusters deployed in this project. format: int64 readOnly: true created: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" name: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the project included in the MongoDB Cloud organization. orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs. example: 32b6e34b3d91647abb20e7b8 regionUsageRestrictions: type: string 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. externalDocs: url: https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions default: COMMERCIAL_FEDRAMP_REGIONS_ONLY enum: - COMMERCIAL_FEDRAMP_REGIONS_ONLY - GOV_REGIONS_ONLY tags: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" withDefaultAlertsSettings: type: boolean description: Flag that indicates whether to create the project with default alert settings. This setting cannot be updated after project creation. default: true PaginatedAtlasGroupView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/Group" totalCount: minimum: 0 type: integer 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 readOnly: true ResourceTag: title: Resource Tag required: - key - value type: object properties: key: maxLength: 255 minLength: 1 type: string description: 'Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.' value: maxLength: 255 minLength: 1 type: string description: 'Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.' description: 'Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.' OrganizationSettings: type: object properties: apiAccessListRequired: type: boolean 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. genAIFeaturesEnabled: type: boolean 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/ x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: true maxServiceAccountSecretValidityInHours: maximum: 8760 minimum: 8 type: integer 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 multiFactorAuthRequired: type: boolean 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/.' restrictEmployeeAccess: type: boolean 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/.' securityContact: type: string 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). streamsCrossGroupEnabled: type: boolean description: Flag that indicates whether a group's Atlas Stream Processing instances in this organization can create connections to other group's clusters in the same organization. description: Collection of settings that configures the organization. PaginatedAppUserView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/CloudAppUser" totalCount: minimum: 0 type: integer 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 readOnly: true TargetOrg: required: - linkToken type: object properties: linkToken: type: string description: Link token that contains all the information required to complete the link. TargetOrgRequest: type: object properties: accessListIps: type: array description: IP address access list entries associated with the API key. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: One IP address access list entry associated with the API key. AvailableClustersDeployment: title: Available Clusters required: - featureCompatibilityVersion - managed - mongoDBVersion - name - sharded - tlsEnabled type: object properties: agentVersion: type: string description: Version of MongoDB Agent that monitors/manages the cluster. readOnly: true clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 dbSizeBytes: type: integer description: Size of this database on disk at the time of the request expressed in bytes. format: int64 readOnly: true example: 8192 featureCompatibilityVersion: type: string description: Version of MongoDB features that this cluster supports. readOnly: true externalDocs: description: MongoDB feature versions url: https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion managed: type: boolean description: Flag that indicates whether Automation manages this cluster. readOnly: true mongoDBVersion: type: string description: Version of MongoDB that this cluster runs. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation name: type: string description: Human-readable label that identifies this cluster. readOnly: true example: Project X sharded cluster oplogSizeMB: type: integer description: Size of the Oplog on disk at the time of the request expressed in MB. format: int32 readOnly: true example: 3 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation sharded: type: boolean description: |- Flag that indicates whether someone configured this cluster as a sharded cluster. - If `true`, this cluster serves as a sharded cluster. - If `false`, this cluster serves as a replica set. readOnly: true shardsSize: type: integer description: Number of shards that comprise this cluster. format: int32 readOnly: true example: 3 tlsEnabled: type: boolean description: Flag that indicates whether someone enabled TLS for this cluster. readOnly: true description: Deployments that can be migrated to MongoDB Atlas. LiveImportAvailableProject: required: - name - projectId type: object properties: deployments: type: array description: List of clusters that can be migrated to MongoDB Cloud. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AvailableClustersDeployment" migrationHosts: type: array description: Hostname of MongoDB Agent list that you configured to perform a migration. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Hostname of MongoDB Agent that you configured to perform a migration. name: maxLength: 64 minLength: 1 type: string description: Human-readable label that identifies this project. readOnly: true projectId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project to be migrated. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-avoid-project-field-names: Schema predates IPA validation LiveMigrationResponse: type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the migration job. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation lagTimeSeconds: type: integer 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 migrationHosts: type: array description: List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation 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]+)?$" type: string 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 readyForCutover: type: boolean description: Flag that indicates the migrated cluster can be cut over to MongoDB Atlas. readOnly: true status: type: string 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. readOnly: true enum: - NEW - WORKING - FAILED - COMPLETE - EXPIRED Destination: required: - clusterName - groupId - hostnameSchemaType type: object properties: clusterName: minLength: 1 type: string description: Label that identifies the destination cluster. groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the destination project. example: 32b6e34b3d91647abb20e7b8 hostnameSchemaType: minLength: 1 type: string description: The network type to use between the migration host and the destination cluster. enum: - PUBLIC - PRIVATE_LINK - VPC_PEERING - PUBLIC - PRIVATE_LINK - VPC_PEERING privateLinkId: type: string description: Represents the endpoint to use when the host schema type is `PRIVATE_LINK`. description: Document that describes the destination of the migration. LiveMigrationRequest: required: - destination - dropEnabled - source type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the migration request. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation destination: "$ref": "#/components/schemas/Destination" dropEnabled: type: boolean description: Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts. writeOnly: true migrationHosts: maxItems: 1 minItems: 1 type: array description: List of migration hosts used for this migration. items: type: string example: vm001.example.com sharding: "$ref": "#/components/schemas/ShardingRequest" source: "$ref": "#/components/schemas/Source" ShardEntry: required: - collection - database - shardCollection type: object properties: collection: type: string description: Human-readable label that identifies the collection to be sharded on the destination cluster. writeOnly: true database: type: string description: Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster. writeOnly: true shardCollection: "$ref": "#/components/schemas/ShardKeys" description: Sharding configuration for a collection to be sharded on the destination cluster. ShardKeys: type: object properties: key: uniqueItems: true type: array description: List of fields to use for the shard key. writeOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: object additionalProperties: type: object description: Document that configures the shard key on the destination cluster. writeOnly: true ShardingRequest: required: - createSupportingIndexes type: object properties: createSupportingIndexes: type: boolean 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. writeOnly: true shardingEntries: uniqueItems: true type: array description: List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array. writeOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ShardEntry" 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. writeOnly: true Source: required: - clusterName - groupId - managedAuthentication - ssl type: object properties: caCertificatePath: type: string description: Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster. clusterName: minLength: 1 type: string description: Label that identifies the source cluster name. groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the source project. example: 32b6e34b3d91647abb20e7b8 managedAuthentication: type: boolean description: Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password. password: type: string description: Password that authenticates the username to the source cluster. writeOnly: true ssl: type: boolean description: Flag that indicates whether you have SSL enabled. username: type: string description: Label that identifies the SCRAM-SHA user that connects to the source cluster. writeOnly: true description: Document that describes the source of the migration. LiveImportValidation: type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the validation. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation errorMessage: type: string description: Reason why the validation job failed. nullable: true readOnly: true groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project to validate. readOnly: true example: 32b6e34b3d91647abb20e7b8 sourceGroupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the source project. example: 32b6e34b3d91647abb20e7b8 status: type: string description: State of the specified validation job returned at the time of the request. nullable: true readOnly: true enum: - PENDING - SUCCESS - FAILED AuthFederationRoleMapping: title: Federated Authentication Role Mapping required: - externalGroupName type: object properties: externalGroupName: maxLength: 200 minLength: 1 type: string description: Unique human-readable label that identifies the identity provider group to which this role mapping applies. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this role mapping. readOnly: true example: 32b6e34b3d91647abb20e7b8 roleAssignments: uniqueItems: true type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ConnectedOrgConfigRoleAssignment" description: Mapping settings that link one IdP and MongoDB Cloud. ConnectedOrgConfigRoleAssignment: type: object properties: groupId: pattern: "^([a-f0-9]{24})$" type: string 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 orgId: pattern: "^([a-f0-9]{24})$" type: string 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 role: type: string description: Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER ConnectedOrgConfig: required: - domainRestrictionEnabled - orgId type: object properties: dataAccessIdentityProviderIds: uniqueItems: true type: array description: The collection of unique ids representing the identity providers that can be used for data access in this organization. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization. domainAllowList: uniqueItems: true type: array description: Approved domains that restrict users who can join the organization based on their email address. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string domainRestrictionEnabled: type: boolean description: Value that indicates whether domain restriction is enabled for this connected org. identityProviderId: pattern: "^([a-f0-9]{20})$" type: string description: Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config 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. orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the connected organization configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 postAuthRoleGrants: uniqueItems: true type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY roleMappings: uniqueItems: true type: array description: Role mappings that are configured in this organization. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AuthFederationRoleMapping" userConflicts: type: array description: List that contains the users who have an email address that doesn't match any domain on the allowed list. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/FederatedUser" FederatedUser: title: Federated User required: - emailAddress - federationSettingsId - firstName - lastName type: object properties: emailAddress: type: string description: Email address of the MongoDB Cloud user linked to the federated organization. format: email federationSettingsId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs. example: 32b6e34b3d91647abb20e7b8 firstName: type: string description: First or given name that belongs to the MongoDB Cloud user. lastName: type: string description: Last name, family name, or surname that belongs to the MongoDB Cloud user. userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this user. readOnly: true example: 32b6e34b3d91647abb20e7b8 description: MongoDB Cloud user linked to this federated authentication. PaginatedConnectedOrgConfigsView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ConnectedOrgConfig" totalCount: minimum: 0 type: integer 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 readOnly: true PaginatedRoleMappingView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/AuthFederationRoleMapping" totalCount: minimum: 0 type: integer 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 readOnly: true description: List role mappings from the specified organization in the specified federation. FederationIdentityProvider: required: - id - oktaIdpId type: object properties: associatedOrgs: uniqueItems: true type: array description: List that contains the connected organization configurations associated with the identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ConnectedOrgConfig" createdAt: type: string 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 description: type: string description: The description of the identity provider. displayName: type: string description: Human-readable label that identifies the identity provider. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the identity provider. readOnly: true example: 32b6e34b3d91647abb20e7b8 idpType: type: string description: String enum that indicates the type of the identity provider. Default is WORKFORCE. enum: - WORKFORCE - WORKLOAD issuerUri: type: string description: Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL. oktaIdpId: pattern: "^([a-f0-9]{20})$" type: string description: Legacy 20-hexadecimal digit string that identifies the identity provider. protocol: type: string description: String enum that indicates the protocol of the identity provider. Either SAML or OIDC. enum: - SAML - OIDC updatedAt: type: string 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 x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/FederationSamlIdentityProvider" - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProvider" - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProvider" FederationOidcWorkforceIdentityProvider: title: OIDC WORKFORCE required: - id - oktaIdpId type: object properties: associatedDomains: uniqueItems: true type: array description: List that contains the domains associated with the identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string associatedOrgs: uniqueItems: true type: array description: List that contains the connected organization configurations associated with the identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ConnectedOrgConfig" audience: type: string description: Identifier of the intended recipient of the token. authorizationType: type: string description: Indicates whether authorization is granted based on group membership or user ID. enum: - GROUP - USER clientId: type: string description: Client identifier that is assigned to an application by the Identity Provider. createdAt: type: string 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 description: type: string description: The description of the identity provider. displayName: type: string description: Human-readable label that identifies the identity provider. groupsClaim: type: string description: Identifier of the claim which contains IdP Group IDs in the token. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the identity provider. readOnly: true example: 32b6e34b3d91647abb20e7b8 idpType: type: string description: String enum that indicates the type of the identity provider. Default is WORKFORCE. enum: - WORKFORCE - WORKLOAD issuerUri: type: string description: Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL. oktaIdpId: pattern: "^([a-f0-9]{20})$" type: string description: Legacy 20-hexadecimal digit string that identifies the identity provider. protocol: type: string description: String enum that indicates the protocol of the identity provider. Either SAML or OIDC. enum: - SAML - OIDC requestedScopes: type: array description: Scopes that MongoDB applications will request from the authorization endpoint. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string updatedAt: type: string 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 userClaim: type: string description: Identifier of the claim which contains the user ID in the token. FederationOidcWorkloadIdentityProvider: title: OIDC WORKLOAD required: - id - oktaIdpId type: object properties: associatedOrgs: uniqueItems: true type: array description: List that contains the connected organization configurations associated with the identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ConnectedOrgConfig" audience: type: string description: Identifier of the intended recipient of the token. authorizationType: type: string description: Indicates whether authorization is granted based on group membership or user ID. enum: - GROUP - USER createdAt: type: string 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 description: type: string description: The description of the identity provider. displayName: type: string description: Human-readable label that identifies the identity provider. groupsClaim: type: string description: Identifier of the claim which contains IdP Group IDs in the token. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the identity provider. readOnly: true example: 32b6e34b3d91647abb20e7b8 idpType: type: string description: String enum that indicates the type of the identity provider. Default is WORKFORCE. enum: - WORKFORCE - WORKLOAD issuerUri: type: string description: Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL. oktaIdpId: pattern: "^([a-f0-9]{20})$" type: string description: Legacy 20-hexadecimal digit string that identifies the identity provider. protocol: type: string description: String enum that indicates the protocol of the identity provider. Either SAML or OIDC. enum: - SAML - OIDC updatedAt: type: string 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 userClaim: type: string description: Identifier of the claim which contains the user ID in the token. FederationSamlIdentityProvider: title: SAML required: - id - oktaIdpId type: object properties: acsUrl: type: string description: URL that points to where to send the SAML response. associatedDomains: uniqueItems: true type: array description: List that contains the domains associated with the identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string associatedOrgs: uniqueItems: true type: array description: List that contains the connected organization configurations associated with the identity provider. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ConnectedOrgConfig" audienceUri: type: string description: Unique string that identifies the intended audience of the SAML assertion. createdAt: type: string 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 description: type: string description: The description of the identity provider. displayName: type: string description: Human-readable label that identifies the identity provider. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the identity provider. readOnly: true example: 32b6e34b3d91647abb20e7b8 idpType: type: string description: String enum that indicates the type of the identity provider. Default is WORKFORCE. enum: - WORKFORCE - WORKLOAD issuerUri: type: string description: Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL. oktaIdpId: pattern: "^([a-f0-9]{20})$" type: string description: Legacy 20-hexadecimal digit string that identifies the identity provider. pemFileInfo: "$ref": "#/components/schemas/PemFileInfo" protocol: type: string description: String enum that indicates the protocol of the identity provider. Either SAML or OIDC. enum: - SAML - OIDC requestBinding: type: string description: SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - HTTP-POST - HTTP-REDIRECT responseSignatureAlgorithm: type: string description: Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - SHA-1 - SHA-256 slug: type: string description: Custom SSO Url for the identity provider. ssoDebugEnabled: type: boolean description: Flag that indicates whether the identity provider has SSO debug enabled. ssoUrl: type: string description: URL that points to the receiver of the SAML authentication request. status: type: string description: String enum that indicates whether the identity provider is active. enum: - ACTIVE - INACTIVE updatedAt: type: string 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 PaginatedFederationIdentityProvider: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/FederationIdentityProvider" totalCount: minimum: 0 type: integer 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 readOnly: true PemFileInfo: type: object properties: certificates: type: array description: List of certificates in the file. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/X509Certificate" fileName: type: string description: Human-readable label given to the file. description: PEM file information for the identity provider's current certificates. X509Certificate: type: object properties: notAfter: type: string description: Latest date that the certificate is valid. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time notBefore: type: string description: Earliest date that the certificate is valid. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time Datadog: title: DATADOG required: - apiKey type: object properties: apiKey: type: string 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" id: type: string description: Integration id. nullable: true region: type: string description: Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. externalDocs: description: Datadog regions url: https://docs.datadoghq.com/getting_started/site/ enum: - US - EU - US3 - US5 - AP1 - US1_FED sendCollectionLatencyMetrics: type: boolean description: Toggle sending collection latency metrics that includes database names and collection namesand latency metrics on reads, writes, commands, and transactions. default: false sendDatabaseMetrics: type: boolean description: Toggle sending database metrics that includes database names and metrics on the number of collections, storage size, and index size. default: false sendUserProvidedResourceTags: type: boolean description: Toggle sending user provided group and cluster resource tags with the datadog metrics. default: false type: type: string 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 description: Details to integrate one Datadog account with one MongoDB Cloud project. MicrosoftTeams: title: MICROSOFT_TEAMS required: - microsoftTeamsWebhookUrl type: object properties: id: type: string description: Integration id. nullable: true microsoftTeamsWebhookUrl: type: string 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: type: string 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 description: Details to integrate one Microsoft Teams account with one MongoDB Cloud project. NewRelic: title: NEW_RELIC required: - accountId - licenseKey - readToken - writeToken type: object properties: accountId: pattern: "^([0-9a-f]){40}$" type: string description: Unique 40-hexadecimal digit string that identifies your New Relic account. example: bcc3c81b344a6030a3935c2527e2216535af7718 id: type: string description: Integration id. nullable: true licenseKey: pattern: "^([0-9a-f]){40}$" type: string 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 readToken: type: string description: Query key used to access your New Relic account. example: 193c96aee4a3ac640b98634562e2631f17ae0a69 writeToken: type: string description: Insert key associated with your New Relic account. example: a67b10e5cd7f8fb6a34b501136c409f373edc218 type: type: string 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 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. To learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. OpsGenie: title: OPS_GENIE required: - apiKey type: object properties: apiKey: type: string 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" id: type: string description: Integration id. nullable: true region: type: string description: Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API. default: US enum: - US - EU type: type: string 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 description: Details to integrate one Opsgenie account with one MongoDB Cloud project. PagerDuty: title: PAGER_DUTY required: - serviceKey type: object properties: id: type: string description: Integration id. nullable: true region: type: string description: PagerDuty region that indicates the API Uniform Resource Locator (URL) to use. enum: - US - EU serviceKey: type: string 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: type: string 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 description: Details to integrate one PagerDuty account with one MongoDB Cloud project. PaginatedIntegrationView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ThirdPartyIntegration" totalCount: minimum: 0 type: integer 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 readOnly: true Prometheus: title: PROMETHEUS required: - enabled - serviceDiscovery - username type: object properties: enabled: type: boolean description: Flag that indicates whether someone has activated the Prometheus integration. id: type: string description: Integration id. nullable: true sendUserProvidedResourceTagsEnabled: type: boolean description: Toggle sending user provided group and cluster resource tags with the prometheus metrics. default: false serviceDiscovery: type: string description: Desired method to discover the Prometheus service. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - http - file username: type: string description: Human-readable label that identifies your Prometheus incoming webhook. example: prom_user_618d48e05277a606ed2496fe password: type: string description: Password needed to allow MongoDB Cloud to access your Prometheus account. writeOnly: true type: type: string 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 description: Details to integrate one Prometheus account with one MongoDB Cloud project. Slack: title: SLACK required: - apiToken - channelName type: object properties: apiToken: type: string 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" channelName: maxLength: 80 minLength: 1 type: string description: Name of the Slack channel to which MongoDB Cloud sends alert notifications. nullable: true example: alerts id: type: string description: Integration id. nullable: true teamName: type: string description: Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration. example: MongoDB type: type: string 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 description: Details to integrate one Slack account with one MongoDB Cloud project. ThirdPartyIntegration: title: Third-Party Integration type: object properties: id: type: string description: Integration id. nullable: true type: title: Integration Type type: string description: Integration type. enum: - PAGER_DUTY - SLACK - DATADOG - NEW_RELIC - OPS_GENIE - VICTOR_OPS - WEBHOOK - HIP_CHAT - PROMETHEUS - MICROSOFT_TEAMS description: Collection of settings that describe third-party integrations. discriminator: propertyName: type mapping: PAGER_DUTY: "#/components/schemas/PagerDuty" SLACK: "#/components/schemas/Slack" DATADOG: "#/components/schemas/Datadog" NEW_RELIC: "#/components/schemas/NewRelic" OPS_GENIE: "#/components/schemas/OpsGenie" VICTOR_OPS: "#/components/schemas/VictorOps" WEBHOOK: "#/components/schemas/Webhook" PROMETHEUS: "#/components/schemas/Prometheus" MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" VictorOps: title: VICTOR_OPS required: - apiKey type: object properties: apiKey: type: string 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" id: type: string description: Integration id. nullable: true routingKey: type: string description: Routing key associated with your Splunk On-Call account. example: test routing type: type: string 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 description: Details to integrate one Splunk On-Call account with one MongoDB Cloud project. Webhook: title: WEBHOOK required: - url type: object properties: id: type: string description: Integration id. nullable: true secret: type: string 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 url: type: string 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: type: string 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 description: Details to integrate one webhook with one MongoDB Cloud project. GroupInvitation: type: object properties: createdAt: type: string 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 expiresAt: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 groupName: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the project to which you invited the MongoDB Cloud user. readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the invitation. readOnly: true example: 32b6e34b3d91647abb20e7b8 inviterUsername: type: string description: Email address of the MongoDB Cloud user who sent the invitation. format: email readOnly: true links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" roles: uniqueItems: true type: array description: One or more organization or project level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER username: type: string description: Email address of the MongoDB Cloud user invited to join the project. format: email readOnly: true GroupInvitationRequest: type: object properties: roles: uniqueItems: true type: array description: One or more project level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER username: type: string description: Email address of the MongoDB Cloud user invited to the specified project. format: email GroupInvitationUpdateRequest: type: object properties: roles: uniqueItems: true type: array description: One or more project-level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER PaginatedTeamRoleView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/TeamRole" totalCount: minimum: 0 type: integer 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 readOnly: true TeamRole: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" roleNames: uniqueItems: true type: array description: One or more project-level roles to assign to the team. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER teamId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the team. example: 32b6e34b3d91647abb20e7b8 BillingInvoiceMetadata: type: object properties: amountBilledCents: type: integer 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 amountPaidCents: type: integer 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 created: type: string 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 creditsCents: type: integer 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 endDate: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. readOnly: true example: 32b6e34b3d91647abb20e7b8 linkedInvoices: type: array description: List that contains the invoices for organizations linked to the paying organization. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BillingInvoiceMetadata" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud. readOnly: true example: 32b6e34b3d91647abb20e7b8 salesTaxCents: type: integer 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 startDate: type: string 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 startingBalanceCents: type: integer 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 statusName: type: string 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 subtotalCents: type: integer 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 updated: type: string 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 PaginatedApiInvoiceMetadataView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BillingInvoiceMetadata" totalCount: minimum: 0 type: integer 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 readOnly: true BillingInvoice: type: object properties: amountBilledCents: type: integer 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 amountPaidCents: type: integer 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 created: type: string 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 creditsCents: type: integer 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 endDate: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. readOnly: true example: 32b6e34b3d91647abb20e7b8 lineItems: type: array description: List that contains individual services included in this invoice. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/InvoiceLineItem" linkedInvoices: type: array description: List that contains the invoices for organizations linked to the paying organization. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BillingInvoice" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud. readOnly: true example: 32b6e34b3d91647abb20e7b8 payments: type: array description: List that contains funds transferred to MongoDB to cover the specified service noted in this invoice. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BillingPayment" refunds: type: array description: List that contains payments that MongoDB returned to the organization for this invoice. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BillingRefund" salesTaxCents: type: integer 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 startDate: type: string 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 startingBalanceCents: type: integer 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 statusName: type: string 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 subtotalCents: type: integer 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 updated: type: string 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 BillingPayment: title: Payment type: object properties: amountBilledCents: type: integer 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 amountPaidCents: type: integer 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 created: type: string 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 currency: type: string description: The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code. readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice. readOnly: true example: 32b6e34b3d91647abb20e7b8 salesTaxCents: type: integer 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 statusName: type: string 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 subtotalCents: type: integer 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 unitPrice: type: string description: The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string. readOnly: true updated: type: string 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 description: Funds transferred to MongoDB to cover the specified service in this invoice. BillingRefund: title: Refund type: object properties: amountCents: type: integer description: Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar). format: int64 readOnly: true created: type: string 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 paymentId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the payment that the organization had made. readOnly: true example: 32b6e34b3d91647abb20e7b8 reason: type: string description: Justification that MongoDB accepted to return funds to the organization. readOnly: true description: One payment that MongoDB returned to the organization for this invoice. InvoiceLineItem: title: Line Item type: object properties: clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster that incurred the charge. readOnly: true created: type: string 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 discountCents: type: integer 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 endDate: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project associated to this line item. readOnly: true example: 32b6e34b3d91647abb20e7b8 groupName: type: string description: Human-readable label that identifies the project. note: type: string description: Comment that applies to this line item. readOnly: true percentDiscount: type: number description: Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies. format: float readOnly: true quantity: type: number 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 sku: type: string 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. readOnly: true enum: - CLASSIC_BACKUP_OPLOG - CLASSIC_BACKUP_STORAGE - CLASSIC_BACKUP_SNAPSHOT_CREATE - CLASSIC_BACKUP_DAILY_MINIMUM - CLASSIC_BACKUP_FREE_TIER - CLASSIC_COUPON - BACKUP_STORAGE_FREE_TIER - BACKUP_STORAGE - FLEX_CONSULTING - CLOUD_MANAGER_CLASSIC - CLOUD_MANAGER_BASIC_FREE_TIER - CLOUD_MANAGER_BASIC - CLOUD_MANAGER_PREMIUM - CLOUD_MANAGER_FREE_TIER - CLOUD_MANAGER_STANDARD_FREE_TIER - CLOUD_MANAGER_STANDARD_ANNUAL - CLOUD_MANAGER_STANDARD - CLOUD_MANAGER_FREE_TRIAL - ATLAS_INSTANCE_M0 - ATLAS_INSTANCE_M2 - ATLAS_INSTANCE_M5 - ATLAS_AWS_INSTANCE_M10 - ATLAS_AWS_INSTANCE_M20 - ATLAS_AWS_INSTANCE_M30 - ATLAS_AWS_INSTANCE_M40 - ATLAS_AWS_INSTANCE_M50 - ATLAS_AWS_INSTANCE_M60 - ATLAS_AWS_INSTANCE_M80 - ATLAS_AWS_INSTANCE_M100 - ATLAS_AWS_INSTANCE_M140 - ATLAS_AWS_INSTANCE_M200 - ATLAS_AWS_INSTANCE_M300 - ATLAS_AWS_INSTANCE_M40_LOW_CPU - ATLAS_AWS_INSTANCE_M50_LOW_CPU - ATLAS_AWS_INSTANCE_M60_LOW_CPU - ATLAS_AWS_INSTANCE_M80_LOW_CPU - ATLAS_AWS_INSTANCE_M200_LOW_CPU - ATLAS_AWS_INSTANCE_M300_LOW_CPU - ATLAS_AWS_INSTANCE_M400_LOW_CPU - ATLAS_AWS_INSTANCE_M700_LOW_CPU - ATLAS_AWS_INSTANCE_M40_NVME - ATLAS_AWS_INSTANCE_M50_NVME - ATLAS_AWS_INSTANCE_M60_NVME - ATLAS_AWS_INSTANCE_M80_NVME - ATLAS_AWS_INSTANCE_M200_NVME - ATLAS_AWS_INSTANCE_M400_NVME - ATLAS_AWS_INSTANCE_M10_PAUSED - ATLAS_AWS_INSTANCE_M20_PAUSED - ATLAS_AWS_INSTANCE_M30_PAUSED - ATLAS_AWS_INSTANCE_M40_PAUSED - ATLAS_AWS_INSTANCE_M50_PAUSED - ATLAS_AWS_INSTANCE_M60_PAUSED - ATLAS_AWS_INSTANCE_M80_PAUSED - ATLAS_AWS_INSTANCE_M100_PAUSED - ATLAS_AWS_INSTANCE_M140_PAUSED - ATLAS_AWS_INSTANCE_M200_PAUSED - ATLAS_AWS_INSTANCE_M300_PAUSED - ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED - ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED - ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME - ATLAS_AWS_SEARCH_INSTANCE_S40_STORAGE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S50_STORAGE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S60_STORAGE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S80_STORAGE_NVME - ATLAS_AWS_SEARCH_INSTANCE_S90_STORAGE_NVME - ATLAS_AWS_STORAGE_PROVISIONED - ATLAS_AWS_STORAGE_STANDARD - ATLAS_AWS_STORAGE_STANDARD_GP3 - ATLAS_AWS_STORAGE_IOPS - ATLAS_AWS_DATA_TRANSFER_SAME_REGION - ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION - ATLAS_AWS_DATA_TRANSFER_INTERNET - ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE - ATLAS_AWS_BACKUP_DOWNLOAD_VM - ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE - ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS - ATLAS_AWS_PRIVATE_ENDPOINT - ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS - ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD - ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD - ATLAS_GCP_INSTANCE_M10 - ATLAS_GCP_INSTANCE_M20 - ATLAS_GCP_INSTANCE_M30 - ATLAS_GCP_INSTANCE_M40 - ATLAS_GCP_INSTANCE_M50 - ATLAS_GCP_INSTANCE_M60 - ATLAS_GCP_INSTANCE_M80 - ATLAS_GCP_INSTANCE_M140 - ATLAS_GCP_INSTANCE_M200 - ATLAS_GCP_INSTANCE_M250 - ATLAS_GCP_INSTANCE_M300 - ATLAS_GCP_INSTANCE_M400 - ATLAS_GCP_INSTANCE_M40_LOW_CPU - ATLAS_GCP_INSTANCE_M50_LOW_CPU - ATLAS_GCP_INSTANCE_M60_LOW_CPU - ATLAS_GCP_INSTANCE_M80_LOW_CPU - ATLAS_GCP_INSTANCE_M200_LOW_CPU - ATLAS_GCP_INSTANCE_M300_LOW_CPU - ATLAS_GCP_INSTANCE_M400_LOW_CPU - ATLAS_GCP_INSTANCE_M600_LOW_CPU - ATLAS_GCP_INSTANCE_M10_PAUSED - ATLAS_GCP_INSTANCE_M20_PAUSED - ATLAS_GCP_INSTANCE_M30_PAUSED - ATLAS_GCP_INSTANCE_M40_PAUSED - ATLAS_GCP_INSTANCE_M50_PAUSED - ATLAS_GCP_INSTANCE_M60_PAUSED - ATLAS_GCP_INSTANCE_M80_PAUSED - ATLAS_GCP_INSTANCE_M140_PAUSED - ATLAS_GCP_INSTANCE_M200_PAUSED - ATLAS_GCP_INSTANCE_M250_PAUSED - ATLAS_GCP_INSTANCE_M300_PAUSED - ATLAS_GCP_INSTANCE_M400_PAUSED - ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED - ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED - ATLAS_GCP_DATA_TRANSFER_INTERNET - ATLAS_GCP_STORAGE_SSD - ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT - ATLAS_GCP_DATA_TRANSFER_INTER_ZONE - ATLAS_GCP_DATA_TRANSFER_INTER_REGION - ATLAS_GCP_DATA_TRANSFER_GOOGLE - ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE - ATLAS_GCP_BACKUP_DOWNLOAD_VM - ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE - ATLAS_GCP_PRIVATE_ENDPOINT - ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS - ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER - ATLAS_AZURE_INSTANCE_M10 - ATLAS_AZURE_INSTANCE_M20 - ATLAS_AZURE_INSTANCE_M30 - ATLAS_AZURE_INSTANCE_M40 - ATLAS_AZURE_INSTANCE_M50 - ATLAS_AZURE_INSTANCE_M60 - ATLAS_AZURE_INSTANCE_M80 - ATLAS_AZURE_INSTANCE_M90 - ATLAS_AZURE_INSTANCE_M200 - ATLAS_AZURE_INSTANCE_R40 - ATLAS_AZURE_INSTANCE_R50 - ATLAS_AZURE_INSTANCE_R60 - ATLAS_AZURE_INSTANCE_R80 - ATLAS_AZURE_INSTANCE_R200 - ATLAS_AZURE_INSTANCE_R300 - ATLAS_AZURE_INSTANCE_R400 - ATLAS_AZURE_INSTANCE_M60_NVME - ATLAS_AZURE_INSTANCE_M80_NVME - ATLAS_AZURE_INSTANCE_M200_NVME - ATLAS_AZURE_INSTANCE_M300_NVME - ATLAS_AZURE_INSTANCE_M400_NVME - ATLAS_AZURE_INSTANCE_M600_NVME - ATLAS_AZURE_INSTANCE_M10_PAUSED - ATLAS_AZURE_INSTANCE_M20_PAUSED - ATLAS_AZURE_INSTANCE_M30_PAUSED - ATLAS_AZURE_INSTANCE_M40_PAUSED - ATLAS_AZURE_INSTANCE_M50_PAUSED - ATLAS_AZURE_INSTANCE_M60_PAUSED - ATLAS_AZURE_INSTANCE_M80_PAUSED - ATLAS_AZURE_INSTANCE_M90_PAUSED - ATLAS_AZURE_INSTANCE_M200_PAUSED - ATLAS_AZURE_INSTANCE_R40_PAUSED - ATLAS_AZURE_INSTANCE_R50_PAUSED - ATLAS_AZURE_INSTANCE_R60_PAUSED - ATLAS_AZURE_INSTANCE_R80_PAUSED - ATLAS_AZURE_INSTANCE_R200_PAUSED - ATLAS_AZURE_INSTANCE_R300_PAUSED - ATLAS_AZURE_INSTANCE_R400_PAUSED - ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD - ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD - ATLAS_AZURE_STORAGE_P2 - ATLAS_AZURE_STORAGE_P3 - ATLAS_AZURE_STORAGE_P4 - ATLAS_AZURE_STORAGE_P6 - ATLAS_AZURE_STORAGE_P10 - ATLAS_AZURE_STORAGE_P15 - ATLAS_AZURE_STORAGE_P20 - ATLAS_AZURE_STORAGE_P30 - ATLAS_AZURE_STORAGE_P40 - ATLAS_AZURE_STORAGE_P50 - ATLAS_AZURE_DATA_TRANSFER - ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN - ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT - ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN - ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT - ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN - ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT - ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT - ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT - ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE - ATLAS_AZURE_BACKUP_DOWNLOAD_VM - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40 - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50 - ATLAS_AZURE_STANDARD_STORAGE - ATLAS_AZURE_EXTENDED_STANDARD_IOPS - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE - ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS - ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE - ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS - ATLAS_BI_CONNECTOR - ATLAS_ADVANCED_SECURITY - ATLAS_ENTERPRISE_AUDITING - ATLAS_FREE_SUPPORT - ATLAS_SUPPORT - ATLAS_NDS_BACKFILL_SUPPORT - STITCH_DATA_DOWNLOADED_FREE_TIER - STITCH_DATA_DOWNLOADED - STITCH_COMPUTE_FREE_TIER - STITCH_COMPUTE - CREDIT - MINIMUM_CHARGE - CHARTS_DATA_DOWNLOADED_FREE_TIER - CHARTS_DATA_DOWNLOADED - ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION - ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION - ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET - ATLAS_DATA_LAKE_AWS_DATA_SCANNED - ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION - ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS - ATLAS_NDS_AWS_DATA_LAKE_STORAGE - ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION - ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT - ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT - ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET - ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION - ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION - ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET - ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED - ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS - ATLAS_NDS_AZURE_DATA_LAKE_STORAGE - ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED - ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS - ATLAS_NDS_GCP_DATA_LAKE_STORAGE - ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS - ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE - ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS - ATLAS_NDS_AZURE_OBJECT_STORAGE - ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE - ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS - ATLAS_NDS_GCP_OBJECT_STORAGE - ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE - ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE - ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER - ATLAS_NDS_AWS_PIT_RESTORE_STORAGE - ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER - ATLAS_NDS_GCP_PIT_RESTORE_STORAGE - ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER - ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE - ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS - ATLAS_NDS_AZURE_CMK_PRIVATE_NETWORKING - ATLAS_NDS_AWS_CMK_PRIVATE_NETWORKING - ATLAS_NDS_AWS_OBJECT_STORAGE - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40 - ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50 - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40 - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50 - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60 - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE - ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS - ATLAS_NDS_GCP_SNAPSHOT_EXPORT_UPLOAD - ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM - ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40 - ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50 - ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60 - ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE - ATLAS_NDS_AWS_SERVERLESS_RPU - ATLAS_NDS_AWS_SERVERLESS_WPU - ATLAS_NDS_AWS_SERVERLESS_STORAGE - ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP - ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM - ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW - ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER - ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL - ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION - ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET - ATLAS_NDS_GCP_SERVERLESS_RPU - ATLAS_NDS_GCP_SERVERLESS_WPU - ATLAS_NDS_GCP_SERVERLESS_STORAGE - ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP - ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM - ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW - ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER - ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL - ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION - ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET - ATLAS_NDS_AZURE_SERVERLESS_RPU - ATLAS_NDS_AZURE_SERVERLESS_WPU - ATLAS_NDS_AZURE_SERVERLESS_STORAGE - ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP - ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM - ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW - ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER - ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL - ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION - ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET - REALM_APP_REQUESTS_FREE_TIER - REALM_APP_REQUESTS - REALM_APP_COMPUTE_FREE_TIER - REALM_APP_COMPUTE - REALM_APP_SYNC_FREE_TIER - REALM_APP_SYNC - REALM_APP_DATA_TRANSFER_FREE_TIER - REALM_APP_DATA_TRANSFER - GCP_SNAPSHOT_COPY_DISK - ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10 - ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30 - ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50 - ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10 - ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30 - ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50 - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING - ATLAS_AZURE_STREAM_PROCESSING_PRIVATELINK - ATLAS_AWS_STREAM_PROCESSING_PRIVATELINK - ATLAS_FLEX_AWS_100_USAGE_HOURS - ATLAS_FLEX_AWS_200_USAGE_HOURS - ATLAS_FLEX_AWS_300_USAGE_HOURS - ATLAS_FLEX_AWS_400_USAGE_HOURS - ATLAS_FLEX_AWS_500_USAGE_HOURS - ATLAS_FLEX_AZURE_100_USAGE_HOURS - ATLAS_FLEX_AZURE_200_USAGE_HOURS - ATLAS_FLEX_AZURE_300_USAGE_HOURS - ATLAS_FLEX_AZURE_400_USAGE_HOURS - ATLAS_FLEX_AZURE_500_USAGE_HOURS - ATLAS_FLEX_GCP_100_USAGE_HOURS - ATLAS_FLEX_GCP_200_USAGE_HOURS - ATLAS_FLEX_GCP_300_USAGE_HOURS - ATLAS_FLEX_GCP_400_USAGE_HOURS - ATLAS_FLEX_GCP_500_USAGE_HOURS - ATLAS_FLEX_AWS_LEGACY_100_USAGE_HOURS - ATLAS_FLEX_AWS_LEGACY_200_USAGE_HOURS - ATLAS_FLEX_AWS_LEGACY_300_USAGE_HOURS - ATLAS_FLEX_AWS_LEGACY_400_USAGE_HOURS - ATLAS_FLEX_AWS_LEGACY_500_USAGE_HOURS - ATLAS_FLEX_AZURE_LEGACY_100_USAGE_HOURS - ATLAS_FLEX_AZURE_LEGACY_200_USAGE_HOURS - ATLAS_FLEX_AZURE_LEGACY_300_USAGE_HOURS - ATLAS_FLEX_AZURE_LEGACY_400_USAGE_HOURS - ATLAS_FLEX_AZURE_LEGACY_500_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_100_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_200_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS - ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP10 - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP30 - ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP50 - ATLAS_GCP_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_GCP_STREAM_PROCESSING_PRIVATELINK startDate: type: string 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 stitchAppName: type: string description: Human-readable label that identifies the Atlas App Services application associated with this line item. readOnly: true externalDocs: description: Create a new Atlas App Service url: https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/ tags: type: object additionalProperties: type: array description: A map of key-value pairs corresponding to the tags associated with the line item resource. readOnly: true items: type: string description: A map of key-value pairs corresponding to the tags associated with the line item resource. readOnly: true description: A map of key-value pairs corresponding to the tags associated with the line item resource. readOnly: true tierLowerBound: type: number 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 tierUpperBound: type: number 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 totalPriceCents: type: integer 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 unit: type: string 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 unitPriceDollars: type: number description: Value per **unit** for this line item expressed in US Dollars. format: double readOnly: true description: One service included in this invoice. PaginatedApiInvoiceView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BillingInvoice" totalCount: minimum: 0 type: integer 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 readOnly: true PaginatedApiUserAccessListResponseView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/UserAccessListResponse" totalCount: minimum: 0 type: integer 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 readOnly: true UserAccessListResponse: type: object properties: cidrBlock: 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 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 count: minimum: 1 type: integer description: Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter. format: int32 readOnly: true created: type: string 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 ipAddress: 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: Network address in the access list for the API key. example: 203.0.113.10 lastUsed: type: string 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 lastUsedAddress: type: string 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. readOnly: true example: 203.0.113.10 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" UserAccessListRequest: type: object properties: cidrBlock: 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 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 ipAddress: 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: 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 PaginatedApiApiUserView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ApiKeyUserDetails" totalCount: minimum: 0 type: integer 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 readOnly: true UpdateAtlasOrganizationApiKey: type: object properties: desc: maxLength: 250 minLength: 1 type: string description: Purpose or explanation provided when someone creates this organization API key. roles: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY GroupRole: type: object properties: groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project to which this role belongs. example: 32b6e34b3d91647abb20e7b8 groupRole: type: string description: Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles. enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER OrganizationInvitation: required: - orgName type: object properties: createdAt: type: string 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 expiresAt: type: string 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 groupRoleAssignments: uniqueItems: true type: array description: List of projects that the user will be added to when they accept their invitation to the organization. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/GroupRole" id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this invitation. readOnly: true example: 32b6e34b3d91647abb20e7b8 inviterUsername: type: string description: Email address of the MongoDB Cloud user who sent the invitation to join the organization. format: email readOnly: true links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" orgId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization. readOnly: true example: 32b6e34b3d91647abb20e7b8 orgName: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies this organization. roles: uniqueItems: true type: array description: One or more organization-level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY teamIds: uniqueItems: true type: array description: List of unique 24-hexadecimal digit strings that identifies each team. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Unique 24-hexadecimal digit string that identifies the team. username: type: string description: Email address of the MongoDB Cloud user invited to join the organization. format: email OrganizationInvitationGroupRoleAssignmentsRequest: type: object properties: groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project to which these roles belong. example: 32b6e34b3d91647abb20e7b8 roles: uniqueItems: true type: array description: One or more project level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER OrganizationInvitationRequest: type: object properties: groupRoleAssignments: type: array description: List of projects that the user will be added to when they accept their invitation to the organization. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" roles: uniqueItems: true type: array description: One or more organization level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY teamIds: uniqueItems: true type: array description: List of teams to which you want to invite the desired MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Unique 24-hexadecimal digit string that identifies the team. username: type: string description: Email address that belongs to the desired MongoDB Cloud user. format: email OrganizationInvitationUpdateRequest: type: object properties: groupRoleAssignments: type: array description: List of projects that the user will be added to when they accept their invitation to the organization. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" roles: uniqueItems: true type: array description: One or more organization level roles to assign to the MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_READ_ONLY teamIds: uniqueItems: true type: array description: List of teams to which you want to invite the desired MongoDB Cloud user. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Unique 24-hexadecimal digit string that identifies the team. UserAccessRoleAssignment: type: object properties: roles: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER userId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the organization API key. readOnly: true example: 32b6e34b3d91647abb20e7b8 CreateAtlasProjectApiKey: required: - desc - roles type: object properties: desc: maxLength: 250 minLength: 1 type: string description: Purpose or explanation provided when someone created this project API key. roles: minItems: 1 type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. enum: - ORG_MEMBER - ORG_READ_ONLY - ORG_STREAM_PROCESSING_ADMIN - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_CLUSTER_MANAGER - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER - GROUP_BACKUP_MANAGER - GROUP_OBSERVABILITY_VIEWER - GROUP_DATABASE_ACCESS_ADMIN UpdateAtlasProjectApiKey: type: object properties: desc: maxLength: 250 minLength: 1 type: string description: Purpose or explanation provided when someone creates this project API key. roles: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - GROUP_BACKUP_MANAGER - GROUP_CLUSTER_MANAGER - GROUP_DATA_ACCESS_ADMIN - GROUP_DATA_ACCESS_READ_ONLY - GROUP_DATA_ACCESS_READ_WRITE - GROUP_DATABASE_ACCESS_ADMIN - GROUP_OBSERVABILITY_VIEWER - GROUP_OWNER - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER AWSCustomDNSEnabledView: required: - enabled type: object properties: enabled: type: boolean description: |- Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS). When `"enabled": true`, connect to your cluster using Private IP for Peering connection strings. externalDocs: description: 'To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.' url: https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns- AuditLog: type: object properties: auditAuthorizationSuccess: type: boolean 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 default: false auditFilter: type: string description: JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\`). externalDocs: description: Custom Auditing Filter url: https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/ configurationType: type: string description: Human-readable label that displays how to configure the audit filter. readOnly: true enum: - NONE - FILTER_BUILDER - FILTER_JSON enabled: type: boolean description: Flag that indicates whether someone enabled database auditing for the specified project. default: false ApiAtlasCheckpointView: type: object properties: clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint. readOnly: true example: 32b6e34b3d91647abb20e7b8 completed: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies checkpoint. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" parts: type: array description: |- Metadata that describes the complete snapshot. - For a replica set, this array contains a single document. - For a sharded cluster, this array contains one document for each shard plus one document for the config host. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ApiCheckpointPartView" restorable: type: boolean description: Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore. readOnly: true started: type: string 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 timestamp: type: string 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 ApiBSONTimestampView: title: BSON Timestamp type: object properties: increment: minimum: 1199145600 type: integer description: Order of the database operation that the oplog recorded at specific date and time. format: int32 readOnly: true example: 1199145600 date: type: string 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 description: BSON timestamp that indicates when the checkpoint token entry in the oplog occurred. readOnly: true ApiCheckpointPartView: type: object properties: replicaSetName: type: string description: Human-readable label that identifies the replica set to which this checkpoint applies. readOnly: true shardName: type: string description: Human-readable label that identifies the shard to which this checkpoint applies. readOnly: true tokenDiscovered: type: boolean description: Flag that indicates whether the token exists. readOnly: true tokenTimestamp: "$ref": "#/components/schemas/ApiBSONTimestampView" typeName: type: string description: Human-readable label that identifies the type of host that the part represents. readOnly: true enum: - REPLICA_SET - CONFIG_SERVER - CONFIG_SERVER_REPLICA_SET description: Metadata contained in one document that describes the complete snapshot taken for this node. readOnly: true PaginatedApiAtlasCheckpointView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ApiAtlasCheckpointView" totalCount: minimum: 0 type: integer 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 readOnly: true ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView: type: object description: Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value. nullable: true x-xgen-IPA-exception: xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation CloudProviderAccessAWSIAMRole: required: - providerName type: object description: Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role. allOf: - "$ref": "#/components/schemas/CloudProviderAccessRole" - type: object properties: atlasAWSAccountArn: maxLength: 2048 minLength: 20 type: string 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. readOnly: true example: arn:aws:iam::772401394250:role/my-test-aws-role x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation atlasAssumedRoleExternalId: type: string 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 authorizedDate: type: string 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 createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" iamAssumedRoleArn: maxLength: 2048 minLength: 20 type: string 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 roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 CloudProviderAccessAzureServicePrincipal: required: - providerName type: object description: Details that describe the features linked to the Azure Service Principal. allOf: - "$ref": "#/components/schemas/CloudProviderAccessRole" - type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation atlasAzureAppId: type: string description: Azure Active Directory Application ID of Atlas. format: uuid createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Azure Service Principal. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" lastUpdatedDate: type: string 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 servicePrincipalId: type: string description: UUID string that identifies the Azure Service Principal. format: uuid tenantId: type: string description: UUID String that identifies the Azure Active Directory Tenant ID. format: uuid CloudProviderAccessDataLakeFeatureUsage: type: object description: Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. allOf: - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" - type: object properties: featureId: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" CloudProviderAccessEncryptionAtRestFeatureUsage: type: object description: Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. allOf: - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" - type: object properties: featureId: "$ref": "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" CloudProviderAccessExportSnapshotFeatureUsage: 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. allOf: - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" - type: object properties: featureId: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" CloudProviderAccessFeatureUsage: type: object properties: featureType: type: string description: Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. readOnly: true enum: - ATLAS_DATA_LAKE - ENCRYPTION_AT_REST - EXPORT_SNAPSHOT - PUSH_BASED_LOG_EXPORT description: MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role. discriminator: propertyName: featureType mapping: ATLAS_DATA_LAKE: "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage" ENCRYPTION_AT_REST: "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage" EXPORT_SNAPSHOT: "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage" PUSH_BASED_LOG_EXPORT: "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" CloudProviderAccessFeatureUsageDataLakeFeatureId: type: object properties: groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies your project. readOnly: true example: 32b6e34b3d91647abb20e7b8 name: type: string description: Human-readable label that identifies the data lake. description: Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. CloudProviderAccessFeatureUsageExportSnapshotFeatureId: type: object properties: exportBucketId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots. readOnly: true example: 32b6e34b3d91647abb20e7b8 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies your project. readOnly: true example: 32b6e34b3d91647abb20e7b8 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. CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId: type: object properties: bucketName: type: string description: Name of the AWS S3 bucket to which your logs will be exported to. readOnly: true groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies your project. readOnly: true example: 32b6e34b3d91647abb20e7b8 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. CloudProviderAccessGCPServiceAccount: required: - providerName type: object description: Details that describe the features linked to the GCP Service Account. allOf: - "$ref": "#/components/schemas/CloudProviderAccessRole" - type: object properties: createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Google Service Account. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" gcpServiceAccountForAtlas: pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" type: string description: Email address for the Google Service Account created by Atlas. roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 status: type: string description: Provision status of the service account. readOnly: true enum: - IN_PROGRESS - COMPLETE - FAILED - NOT_INITIATED CloudProviderAccessPushBasedLogExportFeatureUsage: 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. allOf: - "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" - type: object properties: featureId: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" CloudProviderAccessRole: required: - providerName type: object properties: providerName: type: string description: Human-readable label that identifies the cloud provider of the role. enum: - AWS - AZURE - GCP description: Cloud provider access role. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" CloudProviderAccessAWSIAMRoleRequest: required: - providerName type: object properties: atlasAWSAccountArn: maxLength: 2048 minLength: 20 type: string 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. readOnly: true example: arn:aws:iam::772401394250:role/my-test-aws-role x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation atlasAssumedRoleExternalId: type: string 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 authorizedDate: type: string 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 createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" providerName: type: string description: Human-readable label that identifies the cloud provider of the role. enum: - AWS - AZURE - GCP roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 description: Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role. CloudProviderAccessAzureServicePrincipalRequest: required: - providerName type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation atlasAzureAppId: type: string description: Azure Active Directory Application ID of Atlas. format: uuid createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Azure Service Principal. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" lastUpdatedDate: type: string 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 providerName: type: string description: Human-readable label that identifies the cloud provider of the role. enum: - AWS - AZURE - GCP servicePrincipalId: type: string description: UUID string that identifies the Azure Service Principal. format: uuid tenantId: type: string description: UUID String that identifies the Azure Active Directory Tenant ID. format: uuid description: Details that describe the features linked to the Azure Service Principal. CloudProviderAccessGCPServiceAccountRequest: required: - providerName type: object properties: createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this GCP Service Account. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" gcpServiceAccountForAtlas: type: string description: ID string that identifies the GCP Service Account used by Atlas. readOnly: true providerName: type: string description: Human-readable label that identifies the cloud provider of the role. enum: - AWS - AZURE - GCP roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 description: Details that describe the features linked to the GCP Service Account. CloudProviderAccessRoleRequest: required: - providerName type: object properties: providerName: type: string description: Human-readable label that identifies the cloud provider of the role. enum: - AWS - AZURE - GCP description: Cloud provider access role. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" oneOf: - "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" - "$ref": "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" - "$ref": "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" CloudProviderAccessRoles: type: object properties: awsIamRoles: type: array description: List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRole" azureServicePrincipals: type: array description: List that contains the Azure Service Principals registered with MongoDB Cloud. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessAzureServicePrincipal" gcpServiceAccounts: type: array description: List that contains the Google Service Accounts registered and authorized with MongoDB Cloud. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessGCPServiceAccount" CloudProviderAccessAWSIAMRoleRequestUpdate: required: - providerName type: object description: Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role. allOf: - "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate" - type: object properties: atlasAWSAccountArn: maxLength: 2048 minLength: 20 type: string 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. readOnly: true example: arn:aws:iam::772401394250:role/my-test-aws-role x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation atlasAssumedRoleExternalId: type: string 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 authorizedDate: type: string 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 createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" iamAssumedRoleArn: maxLength: 2048 minLength: 20 type: string 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 roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 CloudProviderAccessAzureServicePrincipalRequestUpdate: required: - providerName type: object description: Details that describe the features linked to the Azure Service Principal. allOf: - "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate" - type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the role. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation atlasAzureAppId: type: string description: Azure Active Directory Application ID of Atlas. format: uuid createdDate: type: string 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 featureUsages: type: array description: List that contains application features associated with this Azure Service Principal. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudProviderAccessFeatureUsage" lastUpdatedDate: type: string 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 servicePrincipalId: type: string description: UUID string that identifies the Azure Service Principal. format: uuid tenantId: type: string description: UUID String that identifies the Azure Active Directory Tenant ID. format: uuid CloudProviderAccessGCPServiceAccountRequestUpdate: required: - providerName type: object description: Details that describe the features linked to the GCP Service Account. allOf: - "$ref": "#/components/schemas/CloudProviderAccessRoleRequestUpdate" CloudProviderAccessRoleRequestUpdate: required: - providerName type: object properties: providerName: type: string description: Human-readable label that identifies the cloud provider of the role. enum: - AWS - AZURE - GCP description: Cloud provider access role. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" AWSCloudProviderContainer: title: AWS required: - regionName type: object description: Collection of settings that configures the network container for a virtual private connection on Amazon Web Services. allOf: - "$ref": "#/components/schemas/CloudProviderContainer" - type: object properties: atlasCidrBlock: 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 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. regionName: type: string description: Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. enum: - US_EAST_1 - US_EAST_2 - US_WEST_1 - US_WEST_2 - CA_CENTRAL_1 - EU_NORTH_1 - EU_WEST_1 - EU_WEST_2 - EU_WEST_3 - EU_CENTRAL_1 - EU_CENTRAL_2 - SA_EAST_1 - AP_EAST_1 - AP_SOUTHEAST_2 - AP_SOUTHEAST_3 - AP_SOUTHEAST_4 - AP_NORTHEAST_1 - AP_NORTHEAST_2 - AP_NORTHEAST_3 - AP_SOUTHEAST_1 - AP_SOUTH_1 - AP_SOUTH_2 - CN_NORTH_1 - CN_NORTHWEST_1 - ME_CENTRAL_1 - ME_SOUTH_1 - AF_SOUTH_1 - EU_SOUTH_1 - EU_SOUTH_2 - IL_CENTRAL_1 - CA_WEST_1 - AP_SOUTHEAST_5 - AP_SOUTHEAST_7 - MX_CENTRAL_1 - GLOBAL - US_GOV_WEST_1 - US_GOV_EAST_1 vpcId: pattern: "^vpc-[0-9a-f]{17}$" type: string description: Unique string that identifies the MongoDB Cloud VPC on AWS. readOnly: true example: vpc-b555d3b0d9cb783b0 AzureCloudProviderContainer: title: AZURE required: - atlasCidrBlock - region type: object description: Collection of settings that configures the network container for a virtual private connection on Amazon Web Services. allOf: - "$ref": "#/components/schemas/CloudProviderContainer" - type: object properties: atlasCidrBlock: 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 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. azureSubscriptionId: pattern: "^([a-f0-9]{24})$" type: string description: Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides. readOnly: true example: 32b6e34b3d91647abb20e7b8 region: type: string description: Azure region to which MongoDB Cloud deployed this network peering container. enum: - US_CENTRAL - US_EAST - US_EAST_2 - US_EAST_2_EUAP - US_NORTH_CENTRAL - US_WEST - US_SOUTH_CENTRAL - EUROPE_NORTH - EUROPE_WEST - US_WEST_CENTRAL - US_WEST_2 - US_WEST_3 - CANADA_EAST - CANADA_CENTRAL - BRAZIL_SOUTH - BRAZIL_SOUTHEAST - AUSTRALIA_EAST - AUSTRALIA_SOUTH_EAST - AUSTRALIA_CENTRAL - AUSTRALIA_CENTRAL_2 - UAE_NORTH - GERMANY_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 vnetName: pattern: "^([-\\w._()])$" type: string description: Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. readOnly: true CloudProviderContainer: type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the network peering container. readOnly: true example: 32b6e34b3d91647abb20e7b8 providerName: type: string description: Cloud service provider that serves the requested network peering containers. enum: - AWS - GCP - AZURE - TENANT - SERVERLESS provisioned: type: boolean description: Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. readOnly: true description: Collection of settings that configures the network container for a virtual private connection on Amazon Web Services. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/AWSCloudProviderContainer" AZURE: "#/components/schemas/AzureCloudProviderContainer" GCP: "#/components/schemas/GCPCloudProviderContainer" oneOf: - "$ref": "#/components/schemas/AzureCloudProviderContainer" - "$ref": "#/components/schemas/GCPCloudProviderContainer" - "$ref": "#/components/schemas/AWSCloudProviderContainer" GCPCloudProviderContainer: title: GCP required: - atlasCidrBlock type: object description: Collection of settings that configures the network container for a virtual private connection on Amazon Web Services. allOf: - "$ref": "#/components/schemas/CloudProviderContainer" - type: object properties: atlasCidrBlock: 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 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. gcpProjectId: pattern: "^p-[0-9a-z]{24}$" type: string 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. readOnly: true networkName: pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" type: string 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. readOnly: true regions: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string 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. x-xgen-IPA-exception: xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation 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 PaginatedCloudProviderContainerView: title: Network Peering type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/CloudProviderContainer" totalCount: minimum: 0 type: integer 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 readOnly: true description: List of Network Peering Containers that Amazon Web Services serves. AvailableCloudProviderRegion: type: object properties: default: type: boolean description: Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2. readOnly: true name: type: string description: Human-readable label that identifies the supported region. readOnly: true CloudProviderRegions: type: object properties: instanceSizes: type: array description: List of instances sizes that this cloud provider supports. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ClusterCloudProviderInstanceSize" provider: type: string description: Human-readable label that identifies the Cloud provider. enum: - AWS - GCP - AZURE ClusterCloudProviderInstanceSize: type: object properties: availableRegions: type: array description: List of regions that this cloud provider supports for this instance size. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AvailableCloudProviderRegion" name: type: string description: Human-readable label that identifies the instance size or cluster tier. readOnly: true PaginatedApiAtlasProviderRegionsView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/CloudProviderRegions" totalCount: minimum: 0 type: integer 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 readOnly: true ClusterStatus: type: object properties: changeStatus: type: string 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 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" AWSHardwareSpec: title: AWS Cluster Hardware Settings type: object properties: instanceSize: title: AWS Instance Sizes type: string description: Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type. 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 diskIOPS: type: integer description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation ebsVolumeType: type: string 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." default: STANDARD enum: - STANDARD - PROVISIONED nodeCount: type: integer description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 description: Hardware specifications for nodes deployed in the region. AWSRegionConfig: title: AWS Regional Replication Specifications type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. allOf: - "$ref": "#/components/schemas/CloudRegionConfig" - type: object properties: analyticsAutoScaling: "$ref": "#/components/schemas/AdvancedAutoScalingSettings" analyticsSpecs: "$ref": "#/components/schemas/DedicatedHardwareSpec" autoScaling: "$ref": "#/components/schemas/AdvancedAutoScalingSettings" readOnlySpecs: "$ref": "#/components/schemas/DedicatedHardwareSpec" AdvancedAutoScalingSettings: title: Automatic Scaling Settings type: object properties: compute: "$ref": "#/components/schemas/AdvancedComputeAutoScaling" diskGB: "$ref": "#/components/schemas/DiskGBAutoScaling" description: Options that determine how this cluster handles resource scaling. AdvancedClusterDescription: type: object properties: acceptDataRisksAndForceReplicaSetReconfig: type: string 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. format: date-time externalDocs: description: Reconfiguring a Replica Set during a regional outage url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set advancedConfiguration: "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView" backupEnabled: type: boolean description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups. x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one default: false biConnector: "$ref": "#/components/schemas/BiConnector" clusterType: type: string description: Configuration of nodes that comprise the cluster. enum: - REPLICASET - SHARDED - GEOSHARDED configServerManagementMode: type: string 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. externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers default: ATLAS_MANAGED enum: - ATLAS_MANAGED - FIXED_TO_DEDICATED configServerType: type: string description: Describes a sharded cluster's config server type. readOnly: true externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers enum: - DEDICATED - EMBEDDED connectionStrings: "$ref": "#/components/schemas/ClusterConnectionStrings" createDate: type: string 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 diskSizeGB: type: number 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 externalDocs: description: Customize Storage url: https://dochub.mongodb.org/core/customize-storage x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation diskWarmingMode: type: string description: Disk warming mode selection. externalDocs: description: Reduce Secondary Disk Warming Impact url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact default: FULLY_WARMED enum: - FULLY_WARMED - VISIBLE_EARLIER encryptionAtRestProvider: type: string description: 'Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.' externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ enum: - NONE - AWS - AZURE - GCP featureCompatibilityVersion: type: string description: Feature compatibility version of the cluster. readOnly: true featureCompatibilityVersionExpirationDate: type: string description: Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true globalClusterSelfManagedSharding: type: boolean 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 labels: type: array 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 deprecated: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ComponentLabel" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mongoDBEmployeeAccessGrant: "$ref": "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string 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. 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- x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one mongoDBVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of MongoDB that the cluster runs. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the advanced cluster. paused: type: boolean description: Flag that indicates whether the cluster is paused. pitEnabled: type: boolean description: Flag that indicates whether the cluster uses continuous cloud backups. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ replicaSetScalingStrategy: type: string 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. externalDocs: description: Modify the Replica Set Scaling Mode url: https://dochub.mongodb.org/core/scale-nodes default: WORKLOAD_TYPE enum: - SEQUENTIAL - WORKLOAD_TYPE - NODE_TYPE replicationSpecs: type: array description: List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ReplicationSpec" rootCertType: type: string description: Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. default: ISRGROOTX1 enum: - ISRGROOTX1 stateName: type: string 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. readOnly: true enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING tags: type: array description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" terminationProtectionEnabled: type: boolean 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. default: false versionReleaseSystem: type: string description: Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. default: LTS enum: - LTS - CONTINUOUS AdvancedComputeAutoScaling: title: Automatic Compute Scaling Settings type: object properties: enabled: type: boolean 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. maxInstanceSize: "$ref": "#/components/schemas/BaseCloudProviderInstanceSize" minInstanceSize: "$ref": "#/components/schemas/BaseCloudProviderInstanceSize" predictiveEnabled: type: boolean description: |- Flag that indicates whether predictive instance size auto-scaling is enabled. - Set to `true` to enable predictive instance size auto-scaling. MongoDB Cloud requires **replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled** to be `true` in order to enable this feature. - Set to `false` to disable predictive instance size auto-scaling. scaleDownEnabled: type: boolean 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**. description: Options that determine how this cluster handles CPU scaling. ApiAtlasClusterAdvancedConfigurationView: type: object properties: customOpensslCipherConfigTls12: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation items: type: string enum: - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 minimumEnabledTlsProtocol: type: string 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. 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 enum: - TLS1_0 - TLS1_1 - TLS1_2 tlsCipherConfigMode: type: string 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 description: Group of settings that configures a subset of the advanced configuration details. AzureHardwareSpec: type: object properties: instanceSize: title: Azure Instance Sizes type: string description: Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type. 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 diskIOPS: type: integer 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. format: int32 externalDocs: description: Programmatic API Keys url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation nodeCount: type: integer description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 AzureRegionConfig: title: Azure Regional Replication Specifications type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. allOf: - "$ref": "#/components/schemas/CloudRegionConfig" - type: object properties: analyticsAutoScaling: "$ref": "#/components/schemas/AdvancedAutoScalingSettings" analyticsSpecs: "$ref": "#/components/schemas/DedicatedHardwareSpec" autoScaling: "$ref": "#/components/schemas/AdvancedAutoScalingSettings" readOnlySpecs: "$ref": "#/components/schemas/DedicatedHardwareSpec" BaseCloudProviderInstanceSize: type: object description: Instance size boundary to which your cluster can automatically scale. readOnly: true oneOf: - title: AWS Instance Sizes type: string enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME - title: Azure 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: GCP 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 BiConnector: title: MongoDB Connector for Business Intelligence Settings type: object properties: enabled: type: boolean description: Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster. readPreference: type: string description: Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes. externalDocs: description: Read preferences for BI Connector url: https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences enum: - PRIMARY - SECONDARY - ANALYTICS 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/ CloudRegionConfig: title: Cloud Service Provider Settings for Multi-Cloud Clusters type: object properties: electableSpecs: "$ref": "#/components/schemas/HardwareSpec" priority: maximum: 7 minimum: 0 type: integer 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 providerName: type: string 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 regionName: type: object 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: - title: AWS 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_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 - AP_SOUTHEAST_5 - AP_SOUTHEAST_7 - MX_CENTRAL_1 - GLOBAL - title: Azure 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 - title: GCP 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 description: Cloud service provider on which MongoDB Cloud provisions the hosts. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/AWSRegionConfig" AZURE: "#/components/schemas/AzureRegionConfig" GCP: "#/components/schemas/GCPRegionConfig" TENANT: "#/components/schemas/TenantRegionConfig" oneOf: - "$ref": "#/components/schemas/AWSRegionConfig" - "$ref": "#/components/schemas/AzureRegionConfig" - "$ref": "#/components/schemas/GCPRegionConfig" - "$ref": "#/components/schemas/TenantRegionConfig" ClusterConnectionStrings: title: Cluster Connection Strings type: object properties: awsPrivateLink: type: object additionalProperties: 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. readOnly: true externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ 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. readOnly: true externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ awsPrivateLinkSrv: type: object additionalProperties: 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. readOnly: true externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ 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. readOnly: true externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ private: type: string 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. readOnly: true externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ privateEndpoint: type: array 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. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" privateSrv: type: string 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/). readOnly: true externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one standard: type: string description: Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol. readOnly: true externalDocs: description: Connection String URI Format url: https://docs.mongodb.com/manual/reference/connection-string/ standardSrv: type: string description: Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. readOnly: true externalDocs: description: Connection String URI Format url: https://docs.mongodb.com/manual/reference/connection-string/ description: Collection of Uniform Resource Locators that point to the MongoDB database. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ ClusterDescriptionConnectionStringsPrivateEndpoint: title: Cluster Private Endpoint Connection String type: object properties: connectionString: type: string description: Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint. readOnly: true endpoints: type: array 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**. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" srvConnectionString: type: string 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 srvShardOptimizedConnectionString: type: string 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: type: string description: MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters. readOnly: true enum: - MONGOD - MONGOS 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/ ClusterDescriptionConnectionStringsPrivateEndpointEndpoint: title: Cluster Private Endpoint Connection Strings Endpoint type: object properties: endpointId: type: string description: Unique string that the cloud provider uses to identify the private endpoint. readOnly: true providerName: type: string description: Cloud provider in which MongoDB Cloud deploys the private endpoint. readOnly: true enum: - AWS - AZURE - GCP region: type: string description: Region where the private endpoint is deployed. readOnly: true description: Details of a private endpoint deployed for this cluster. ComponentLabel: title: Component Label type: object properties: key: maxLength: 255 minLength: 1 type: string description: Key applied to tag and categorize this component. value: maxLength: 255 minLength: 1 type: string description: Value set to the Key applied to tag and categorize this component. description: Human-readable labels applied to this MongoDB Cloud component. DedicatedHardwareSpec: type: object properties: nodeCount: type: integer description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 description: Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region. x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/AWSHardwareSpec" - "$ref": "#/components/schemas/AzureHardwareSpec" - "$ref": "#/components/schemas/GCPHardwareSpec" DiskGBAutoScaling: type: object properties: enabled: type: boolean 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. description: Setting that enables disk auto-scaling. EmployeeAccessGrantView: required: - expirationTime - grantType type: object properties: expirationTime: type: string description: Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time grantType: type: string description: Level of access to grant to MongoDB Employees. enum: - CLUSTER_DATABASE_LOGS - CLUSTER_INFRASTRUCTURE - CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" description: MongoDB employee granted access level and expiration for a cluster. readOnly: true GCPHardwareSpec: type: object properties: instanceSize: title: GCP Instance Sizes type: string description: Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 nodeCount: type: integer description: Number of nodes of the given type for MongoDB Cloud to deploy to the region. format: int32 GCPRegionConfig: title: GCP Regional Replication Specifications type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. allOf: - "$ref": "#/components/schemas/CloudRegionConfig" - type: object properties: analyticsAutoScaling: "$ref": "#/components/schemas/AdvancedAutoScalingSettings" analyticsSpecs: "$ref": "#/components/schemas/DedicatedHardwareSpec" autoScaling: "$ref": "#/components/schemas/AdvancedAutoScalingSettings" readOnlySpecs: "$ref": "#/components/schemas/DedicatedHardwareSpec" HardwareSpec: type: object 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. x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/AWSHardwareSpec" - "$ref": "#/components/schemas/AzureHardwareSpec" - "$ref": "#/components/schemas/GCPHardwareSpec" - "$ref": "#/components/schemas/TenantHardwareSpec" ReplicationSpec: title: Replication Specifications type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request. readOnly: true example: 32b6e34b3d91647abb20e7b8 numShards: minimum: 1 type: integer 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 regionConfigs: type: array 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**. Every hardware specification must use the same **instanceSize**. **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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CloudRegionConfig" zoneId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies a zone in a Global Cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 zoneName: type: string description: 'Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `"clusterType" : "GEOSHARDED"`.' description: Details that explain how MongoDB Cloud replicates data on the specified MongoDB database. TenantHardwareSpec: type: object properties: effectiveInstanceSize: type: string description: The true tenant instance size. This is present to support backwards compatibility for deprecated provider types and/or instance sizes. readOnly: true enum: - FLEX - M2 - M5 - M0 instanceSize: title: Tenant Instance Sizes type: string description: Hardware specification for the instances in this M0/M2/M5 tier cluster. enum: - M0 - M2 - M5 TenantRegionConfig: title: Tenant Regional Replication Specifications type: object description: Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database. allOf: - "$ref": "#/components/schemas/CloudRegionConfig" - type: object properties: backingProviderName: type: string 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 createFlexCluster API for such configurations moving forward." externalDocs: description: createFlexCluster API url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster enum: - AWS - GCP - AZURE PaginatedAdvancedClusterDescriptionView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/AdvancedClusterDescription" totalCount: minimum: 0 type: integer 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 readOnly: true GeoSharding: type: object properties: customZoneMapping: type: object additionalProperties: pattern: "^([a-f0-9]{24})$" 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` `id` property. This parameter returns an empty object if no custom zones exist. readOnly: true example: 32b6e34b3d91647abb20e7b8 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` `id` property. This parameter returns an empty object if no custom zones exist. readOnly: true managedNamespaces: type: array description: List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ManagedNamespaces" selfManagedSharding: type: boolean 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 ManagedNamespaces: required: - collection - customShardKey - db type: object properties: collection: type: string description: Human-readable label of the collection to manage for this Global Cluster. customShardKey: type: string 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. db: type: string description: Human-readable label of the database to manage for this Global Cluster. isCustomShardKeyHashed: type: boolean 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 x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation default: false isShardKeyUnique: type: boolean 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/). x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation default: false numInitialChunks: maximum: 8192 type: integer 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/). format: int64 externalDocs: description: Global Cluster Sharding url: https://www.mongodb.com/docs/atlas/shard-global-collection/ x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one presplitHashedZones: type: boolean 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/ default: false AtlasClusterOutageSimulationOutageFilter: type: object properties: cloudProvider: type: string description: The cloud provider of the region that undergoes the outage simulation. enum: - AWS - GCP - AZURE regionName: type: string description: The name of the region to undergo an outage simulation. type: type: string description: The type of cluster outage to simulate. `REGION` simulates a cluster outage for a region. enum: - REGION ClusterOutageSimulation: type: object properties: clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster that undergoes outage simulation. readOnly: true groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the outage simulation. readOnly: true example: 32b6e34b3d91647abb20e7b8 outageFilters: minItems: 1 type: array description: List of settings that specify the type of cluster outage simulation. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" startRequestDate: type: string 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 state: type: string 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.| readOnly: true x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation enum: - START_REQUESTED - STARTING - SIMULATING - RECOVERY_REQUESTED - RECOVERING - COMPLETE Collation: required: - locale type: object properties: alternate: type: string 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`. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: non-ignorable enum: - non-ignorable - shifted backwards: type: boolean 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. default: false caseFirst: type: string 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. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: 'off' enum: - lower - 'off' - upper caseLevel: type: boolean 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. default: false locale: type: string description: 'International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `"locale" : "simple"`.' x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation 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 maxVariable: type: string description: 'Field that indicates which characters can be ignored when `"alternate" : "shifted"`.`"punct"` ignores both whitespace and punctuation. `"space"` ignores whitespace. Thishas no affect if `"alternate" : "non-ignorable"`.' x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - punct - space normalization: type: boolean 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. default: false numericOrdering: type: boolean 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"`. default: false strength: maximum: 5 minimum: 1 type: integer 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 default: 3 description: One or more settings that specify language-specific rules to compare strings within this index. writeOnly: true externalDocs: description: Collation Options url: https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options DatabaseRollingIndexRequest: required: - collection - db type: object properties: collation: "$ref": "#/components/schemas/Collation" collection: type: string description: Human-readable label of the collection for which MongoDB Cloud creates an index. writeOnly: true db: type: string description: Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index. writeOnly: true keys: type: array description: List that contains one or more objects that describe the parameters that you want to index. writeOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: maxProperties: 1 minProperties: 1 type: object additionalProperties: maxProperties: 1 minProperties: 1 type: string description: Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array. writeOnly: true externalDocs: description: Index Types url: https://docs.mongodb.com/manual/indexes/#index-types description: Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array. writeOnly: true externalDocs: description: Index Types url: https://docs.mongodb.com/manual/indexes/#index-types options: "$ref": "#/components/schemas/IndexOptions" IndexOptions: type: object properties: 2dsphereIndexVersion: type: integer 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: 3 background: type: boolean 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. default: false bits: type: integer 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 default: 26 bucketSize: type: integer 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 columnstoreProjection: type: object additionalProperties: type: integer description: |- The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the 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 description: |- The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the 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. default_language: type: string 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: english expireAfterSeconds: type: integer description: Number of seconds that MongoDB retains documents in a Time To Live (TTL) index. format: int32 hidden: type: boolean 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. default: false language_override: type: string 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: language max: type: integer description: Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only. format: int32 default: 180 min: type: integer description: Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only. format: int32 default: -180 name: type: string description: Human-readable label that identifies this index. This option applies to all index types. partialFilterExpression: type: object additionalProperties: 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. 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. sparse: type: boolean 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. default: false storageEngine: type: object additionalProperties: 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" : { "" : "" }` 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/ description: 'Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `"storageEngine" : { "" : "" }` 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/ textIndexVersion: type: integer 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 default: 3 weights: type: object additionalProperties: 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. 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. description: One or more settings that determine how the MongoDB Cloud creates this MongoDB index. writeOnly: true externalDocs: description: Index Options url: https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options PartialFilter: type: object additionalProperties: 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. 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. StorageEngine: type: object additionalProperties: 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" : { "" : "" }` 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/ description: 'Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `"storageEngine" : { "" : "" }` 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/ Weights: type: object additionalProperties: 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. 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. DatabaseInheritedRole: title: Inherited Role required: - db - role type: object properties: db: type: string description: Human-readable label that identifies the database on which someone grants the action to one MongoDB user. role: type: string 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/ 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/ DatabasePermittedNamespaceResource: title: Permitted Namespace required: - cluster - collection - db type: object properties: cluster: type: boolean 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. collection: type: string 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.' db: type: string 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.' description: Namespace to which this database user has access. externalDocs: description: Cluster Resources url: https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource DatabasePrivilegeAction: title: Database Privilege Action required: - action type: object properties: action: type: string 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 - START_STREAM_PROCESSOR - STOP_STREAM_PROCESSOR - DROP_STREAM_PROCESSOR - SAMPLE_STREAM_PROCESSOR - LIST_STREAM_PROCESSORS - LIST_CONNECTIONS - STREAM_PROCESSOR_STATS resources: type: array description: List of resources on which you grant the action. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DatabasePermittedNamespaceResource" description: Privilege action that the role grants. UserCustomDBRole: required: - roleName type: object properties: actions: type: array description: List of the individual privilege actions that the role grants. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DatabasePrivilegeAction" inheritedRoles: uniqueItems: true type: array description: List of the built-in roles that this custom role inherits. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DatabaseInheritedRole" roleName: type: string description: Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. UpdateCustomDBRole: type: object properties: actions: type: array description: List of the individual privilege actions that the role grants. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DatabasePrivilegeAction" inheritedRoles: uniqueItems: true type: array description: List of the built-in roles that this custom role inherits. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DatabaseInheritedRole" ApiAtlasDataLakeAWSRegionView: type: string 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 ApiAtlasDataLakeStorageView: "$ref": "#/components/schemas/DataLakeStorage" AtlasDataFederationAzureRegion: type: string description: Atlas Data Federation Azure Regions. enum: - VIRGINIA_USA - AMSTERDAM_NLD - SAOPAULO_BRA AtlasDataFederationGCPRegion: type: string description: Atlas Data Federation GCP Regions. enum: - IOWA_USA - BELGIUM_EU BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - "$ref": "#/components/schemas/AtlasDataFederationAzureRegion" - "$ref": "#/components/schemas/AtlasDataFederationGCPRegion" DataFederationAzureCloudProviderConfig: required: - roleId type: object properties: atlasAppId: type: string description: The App ID generated by Atlas for the Service Principal's access policy. readOnly: true roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig. example: 32b6e34b3d91647abb20e7b8 servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources. readOnly: true tenantId: type: string description: The Azure Active Directory / Entra ID tenant ID associated with the Service Principal. readOnly: true description: Configuration for running Data Federation in Azure. DataFederationGCPCloudProviderConfig: required: - roleId type: object properties: gcpServiceAccount: type: string 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 roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig. example: 32b6e34b3d91647abb20e7b8 description: Configuration for running Data Federation in GCP. DataLakeAWSCloudProviderConfig: required: - roleId - testS3Bucket type: object properties: testS3Bucket: type: string description: Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. writeOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation externalId: type: string description: Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores. readOnly: true iamAssumedRoleARN: maxLength: 2048 minLength: 20 type: string description: Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. readOnly: true example: arn:aws:iam::123456789012:root x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation iamUserARN: type: string description: Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. example: 32b6e34b3d91647abb20e7b8 description: Configuration for running Data Federation in AWS. DataLakeCloudProviderConfig: title: Data Federation Cloud Provider type: object properties: aws: "$ref": "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: "$ref": "#/components/schemas/DataFederationAzureCloudProviderConfig" gcp: "$ref": "#/components/schemas/DataFederationGCPCloudProviderConfig" description: Cloud provider where this Federated Database Instance is hosted. DataLakeDataProcessRegion: required: - cloudProvider - region type: object properties: cloudProvider: type: string description: Name of the cloud service that hosts the Federated Database Instance's infrastructure. enum: - AWS - AZURE - GCP region: "$ref": "#/components/schemas/BaseAtlasDataLakeRegion" description: Information about the cloud provider region to which the Federated Database Instance routes client connections. DataLakeTenant: type: object properties: cloudProviderConfig: "$ref": "#/components/schemas/DataLakeCloudProviderConfig" dataProcessRegion: "$ref": "#/components/schemas/DataLakeDataProcessRegion" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostnames: type: array description: List that contains the hostnames assigned to the Federated Database Instance. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Unique hostname assigned to the Federated Database Instance. readOnly: true name: type: string description: Human-readable label that identifies the Federated Database Instance. privateEndpointHostnames: type: array description: List that contains the sets of private endpoints and hostnames. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PrivateEndpointHostname" state: type: string description: Label that indicates the status of the Federated Database Instance. readOnly: true enum: - UNVERIFIED - ACTIVE - DELETED storage: "$ref": "#/components/schemas/DataLakeStorage" PrivateEndpointHostname: type: object properties: hostname: type: string description: Human-readable label that identifies the hostname. readOnly: true privateEndpoint: type: string description: Human-readable label that identifies private endpoint. readOnly: true description: Set of Private endpoint and hostnames. readOnly: true DataFederationTenantQueryLimit: title: Data Federation Tenant-Level Query Limit required: - name - value type: object properties: currentUsage: type: integer description: Amount that indicates the current usage of the limit. format: int64 readOnly: true defaultLimit: type: integer description: Default value of the limit. format: int64 readOnly: true lastModifiedDate: type: string 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 maximumLimit: type: integer description: Maximum value of the limit. format: int64 readOnly: true name: type: string description: Human-readable label that identifies the user-managed limit to modify. readOnly: true overrunPolicy: type: string 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 tenantName: type: string 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 value: type: integer description: Amount to set the limit to. format: int64 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. DLSIngestionSink: title: DLS Ingestion Destination type: object description: Atlas Data Lake Storage as the destination for a Data Lake Pipeline. allOf: - "$ref": "#/components/schemas/IngestionSink" - type: object properties: metadataProvider: type: string description: Target cloud provider for this Data Lake Pipeline. enum: - AWS metadataRegion: type: string description: Target cloud provider region for this Data Lake Pipeline. externalDocs: description: Supported cloud provider regions url: https://www.mongodb.com/docs/datalake/limitations partitionFields: type: array description: Ordered fields used to physically organize data in the destination. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DataLakePipelinesPartitionField" DataLakeIngestionPipeline: title: Data Lake Pipeline type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation createdDate: type: string 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 datasetRetentionPolicy: "$ref": "#/components/schemas/DatasetRetentionPolicy" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the group. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastUpdatedDate: type: string 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 name: type: string description: Name of this Data Lake Pipeline. sink: "$ref": "#/components/schemas/IngestionSink" source: "$ref": "#/components/schemas/IngestionSource" state: type: string description: State of this Data Lake Pipeline. readOnly: true enum: - ACTIVE - PAUSED transformations: type: array description: Fields to be excluded for this Data Lake Pipeline. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/FieldTransformation" description: Details of a Data Lake Pipeline. DataLakePipelinesPartitionField: title: Partition Field required: - fieldName - order type: object properties: fieldName: maxLength: 700 type: string description: Human-readable label that identifies the field name used to partition data. order: type: integer description: Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. format: int32 default: 0 description: Partition Field in the Data Lake Storage provider for a Data Lake Pipeline. DatasetRetentionPolicy: title: Dataset Retention Policy required: - units - value type: object properties: lastModifiedDate: type: string 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 units: type: string description: Quantity of time in which the Data Lake Pipeline measures dataset retention. enum: - DAYS - WEEKS - MONTHS value: minimum: 1 type: integer description: Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets. format: int32 description: Dataset Retention Policy for a Scheduled Data Lake Pipeline. FieldTransformation: title: Field Transformation type: object properties: field: type: string description: Key in the document. type: type: string description: Type of transformation applied during the export of the namespace in a Data Lake Pipeline. enum: - EXCLUDE description: Field Transformations during ingestion of a Data Lake Pipeline. IngestionSink: title: Ingestion Destination type: object properties: type: type: string description: Type of ingestion destination of this Data Lake Pipeline. readOnly: true enum: - DLS description: Ingestion destination of a Data Lake Pipeline. discriminator: propertyName: type mapping: DLS: "#/components/schemas/DLSIngestionSink" IngestionSource: title: Ingestion Source type: object properties: type: type: string description: Type of ingestion source of this Data Lake Pipeline. enum: - PERIODIC_CPS - ON_DEMAND_CPS description: Ingestion Source of a Data Lake Pipeline. discriminator: propertyName: type mapping: ON_DEMAND_CPS: "#/components/schemas/OnDemandCpsSnapshotSource" PERIODIC_CPS: "#/components/schemas/PeriodicCpsSnapshotSource" OnDemandCpsSnapshotSource: title: On-Demand Cloud Provider Snapshot Source type: object description: On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline. allOf: - "$ref": "#/components/schemas/IngestionSource" - type: object properties: clusterName: type: string description: Human-readable name that identifies the cluster. collectionName: type: string description: Human-readable name that identifies the collection. databaseName: type: string description: Human-readable name that identifies the database. groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 PeriodicCpsSnapshotSource: title: Periodic Cloud Provider Snapshot Source type: object description: Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline. allOf: - "$ref": "#/components/schemas/IngestionSource" - type: object properties: clusterName: type: string description: Human-readable name that identifies the cluster. collectionName: type: string description: Human-readable name that identifies the collection. databaseName: type: string description: Human-readable name that identifies the database. groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 policyItemId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies a policy item. example: 32b6e34b3d91647abb20e7b8 DiskBackupApiPolicyItem: required: - frequencyInterval - frequencyType - retentionUnit - retentionValue type: object properties: frequencyInterval: type: integer 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. format: int32 x-xgen-IPA-exception: xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 40 frequencyType: type: string description: Human-readable label that identifies the frequency type associated with the backup policy. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - daily - hourly - weekly - monthly - yearly - ondemand id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this backup policy item. readOnly: true example: 32b6e34b3d91647abb20e7b8 retentionUnit: type: string description: Unit of time in which MongoDB Cloud measures Snapshot retention. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - days - weeks - months - years retentionValue: type: integer 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 description: Specifications for one policy. DiskBackupReplicaSet: title: Replica Set Snapshot type: object properties: cloudProvider: type: string description: 'Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `"type": "replicaSet"`.' readOnly: true enum: - AWS - AZURE - GCP copyRegions: type: array description: List that identifies the regions to which MongoDB Cloud copies the snapshot. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string createdAt: type: string 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 description: type: string description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.' readOnly: true expiresAt: type: string 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 frequencyType: type: string description: Human-readable label that identifies how often this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - hourly - daily - weekly - monthly - yearly id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" masterKeyUUID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongodVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of the MongoDB host that this snapshot backs up. readOnly: true policyItems: type: array description: List that contains unique identifiers for the policy items. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies one policy item. example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string 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 snapshotType: type: string description: Human-readable label that identifies when this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - onDemand - scheduled - fallback status: type: string description: Human-readable label that indicates the stage of the backup process for this snapshot. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - queued - inProgress - completed - failed storageSizeBytes: type: integer description: Number of bytes taken to store the backup at time of snapshot. format: int64 readOnly: true type: type: string description: Human-readable label that categorizes the cluster as a replica set or sharded cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - replicaSet - shardedCluster description: Details of the replica set snapshot that MongoDB Cloud created. DiskBackupShardedClusterSnapshot: title: Sharded Cluster Snapshot type: object properties: configServerType: type: string description: Describes a sharded cluster's config server type. readOnly: true enum: - EMBEDDED - DEDICATED createdAt: type: string 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 description: type: string description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.' readOnly: true expiresAt: type: string 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 frequencyType: type: string description: Human-readable label that identifies how often this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - hourly - daily - weekly - monthly - yearly id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" masterKeyUUID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation members: type: array description: 'List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `"type" : "SHARDED_CLUSTER"`.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshotMember" mongodVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of the MongoDB host that this snapshot backs up. readOnly: true policyItems: type: array description: List that contains unique identifiers for the policy items. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies one policy item. example: 32b6e34b3d91647abb20e7b8 snapshotIds: type: array 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.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 snapshotType: type: string description: Human-readable label that identifies when this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - onDemand - scheduled - fallback status: type: string description: Human-readable label that indicates the stage of the backup process for this snapshot. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - queued - inProgress - completed - failed storageSizeBytes: type: integer description: Number of bytes taken to store the backup at time of snapshot. format: int64 readOnly: true type: type: string description: Human-readable label that categorizes the cluster as a replica set or sharded cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - replicaSet - shardedCluster description: Details of the sharded cluster snapshot that MongoDB Cloud created. DiskBackupShardedClusterSnapshotMember: required: - cloudProvider - id - replicaSetName type: object properties: cloudProvider: type: string description: 'Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `"type": "replicaSet"`.' readOnly: true enum: - AWS - AZURE - GCP id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string description: Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot. readOnly: true DiskBackupSnapshot: type: object properties: createdAt: type: string 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 description: type: string description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.' readOnly: true expiresAt: type: string 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 frequencyType: type: string description: Human-readable label that identifies how often this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - hourly - daily - weekly - monthly - yearly id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" masterKeyUUID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongodVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of the MongoDB host that this snapshot backs up. readOnly: true policyItems: type: array description: List that contains unique identifiers for the policy items. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies one policy item. example: 32b6e34b3d91647abb20e7b8 snapshotType: type: string description: Human-readable label that identifies when this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - onDemand - scheduled - fallback status: type: string description: Human-readable label that indicates the stage of the backup process for this snapshot. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - queued - inProgress - completed - failed storageSizeBytes: type: integer description: Number of bytes taken to store the backup at time of snapshot. format: int64 readOnly: true type: type: string description: Human-readable label that categorizes the cluster as a replica set or sharded cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - replicaSet - shardedCluster discriminator: propertyName: type mapping: replicaSet: "#/components/schemas/DiskBackupReplicaSet" shardedCluster: "#/components/schemas/DiskBackupShardedClusterSnapshot" PaginatedBackupSnapshotView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/DiskBackupSnapshot" totalCount: minimum: 0 type: integer 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 readOnly: true IngestionPipelineRun: title: Data Lake Pipeline Run type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation backupFrequencyType: type: string description: Backup schedule interval of the Data Lake Pipeline. readOnly: true enum: - HOURLY - DAILY - WEEKLY - MONTHLY - YEARLY - ON_DEMAND createdDate: type: string 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 datasetName: type: string 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. readOnly: true example: v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z datasetRetentionPolicy: "$ref": "#/components/schemas/DatasetRetentionPolicy" groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 lastUpdatedDate: type: string 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 phase: type: string description: Processing phase of the Data Lake Pipeline. readOnly: true enum: - SNAPSHOT - EXPORT - INGESTION pipelineId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies a Data Lake Pipeline. readOnly: true example: 32b6e34b3d91647abb20e7b8 scheduledDeletionDate: type: string 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 snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the snapshot of a cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 state: type: string description: State of the pipeline run. readOnly: true enum: - PENDING - IN_PROGRESS - DONE - FAILED - DATASET_DELETED stats: "$ref": "#/components/schemas/PipelineRunStats" description: Run details of a Data Lake Pipeline. PaginatedPipelineRunView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/IngestionPipelineRun" totalCount: minimum: 0 type: integer 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 readOnly: true PipelineRunStats: title: Data Lake Pipeline Run Statistics type: object properties: bytesExported: type: integer description: Total data size in bytes exported for this pipeline run. format: int64 readOnly: true numDocs: type: integer description: Number of docs ingested for a this pipeline run. format: int64 readOnly: true description: Runtime statistics for this Data Lake Pipeline run. readOnly: true TriggerIngestionPipelineRequest: required: - snapshotId type: object properties: datasetRetentionPolicy: "$ref": "#/components/schemas/DatasetRetentionPolicy" snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the snapshot. writeOnly: true example: 32b6e34b3d91647abb20e7b8 CloudDatabaseUser: required: - databaseName - groupId - username type: object properties: awsIAMType: type: string 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: NONE enum: - NONE - USER - ROLE databaseName: type: string 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`. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: admin enum: - admin - "$external" deleteAfterDate: type: string 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 description: maxLength: 100 type: string description: Description of this database user. groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. writeOnly: true labels: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ComponentLabel" ldapAuthType: type: string description: Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host. default: NONE enum: - NONE - GROUP - USER links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" oidcAuthType: type: string 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. default: NONE enum: - NONE - IDP_GROUP - USER password: minLength: 8 type: string 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. writeOnly: true externalDocs: description: SCRAM-SHA url: https://docs.mongodb.com/manual/core/security-scram/ roles: type: array description: List that provides the pairings of one role with one applicable database. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DatabaseUserRole" scopes: type: array description: List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances 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 Instances in the project. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/UserScope" username: maxLength: 1024 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 | ARN | | AWS IAM | awsIAMType | USER | ARN | | 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 | x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation xgen-IPA-117-description-must-not-use-html: Description predates IPA validation xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one x509Type: type: string 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: NONE enum: - NONE - CUSTOMER - MANAGED DatabaseUserRole: title: Database User Role required: - databaseName - roleName type: object properties: collectionName: type: string description: Collection on which this role applies. databaseName: type: string description: Database to which the user is granted access privileges. roleName: type: string 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. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - atlasAdmin - backup - clusterMonitor - dbAdmin - dbAdminAnyDatabase - enableSharding - read - readAnyDatabase - readWrite - readWriteAnyDatabase - "" description: Range of resources available to this database user. UserScope: title: Database User Scope required: - name - type type: object properties: name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access. type: type: string description: Category of resource that this database user can access. enum: - CLUSTER - DATA_LAKE - STREAM description: Range of resources available to this database user. UserCert: type: object properties: _id: type: integer description: Unique 24-hexadecimal character string that identifies this certificate. format: int64 readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation createdAt: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 monthsUntilExpiration: maximum: 24 type: integer description: Number of months that the certificate remains valid until it expires. format: int32 writeOnly: true default: 3 notAfter: type: string 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 subject: pattern: "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" type: string description: Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in RFC 2253. readOnly: true example: CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com externalDocs: description: RFC 2253 url: https://tools.ietf.org/html/2253 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" PaginatedApiAtlasDatabaseUserView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/CloudDatabaseUser" totalCount: minimum: 0 type: integer 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 readOnly: true description: List of MongoDB Database users granted access to databases in the specified project. PaginatedUserCertView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/UserCert" totalCount: minimum: 0 type: integer 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 readOnly: true DiskBackupSnapshotAWSExportBucketResponse: required: - _id - bucketName - cloudProvider - iamRoleId type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation bucketName: maxLength: 63 minLength: 3 type: string description: The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to. example: export-bucket cloudProvider: type: string description: Human-readable label that identifies the cloud provider that Snapshots will be exported to. enum: - AWS - AZURE - GCP iamRoleId: pattern: "^([a-f0-9]{24})$" type: string 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/ links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" region: type: string description: AWS region for the export bucket. This is set by Atlas and is never user-supplied. readOnly: true example: us-east-1 DiskBackupSnapshotAWSExportBucketRequest: required: - bucketName - cloudProvider - iamRoleId type: object properties: bucketName: maxLength: 63 minLength: 3 type: string description: Human-readable label that identifies the AWS S3 Bucket that the role is authorized to export to. example: export-bucket cloudProvider: type: string description: Human-readable label that identifies the cloud provider that Snapshots are exported to. enum: - AWS - AZURE - GCP iamRoleId: pattern: "^([a-f0-9]{24})$" type: string 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/ links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" PaginatedBackupSnapshotExportBucketView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse" totalCount: minimum: 0 type: integer 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 readOnly: true BackupLabel: type: object properties: key: type: string description: Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. value: type: string description: Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes. 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. DiskBackupExportJob: required: - exportBucketId type: object properties: components: type: array description: Information on the export job for each replica set in the sharded cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DiskBackupExportMember" createdAt: type: string 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 customData: type: array description: Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BackupLabel" exportBucketId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the Export Bucket. readOnly: true example: 32b6e34b3d91647abb20e7b8 exportStatus: "$ref": "#/components/schemas/ExportStatus" finishedAt: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the restore job. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" prefix: pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" type: string description: Prefix used for all blob storage objects uploaded as part of the Export Job. readOnly: true snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 state: type: string description: State of the Export Job. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - Cancelled - Failed - InProgress - Queued - Successful stateReason: "$ref": "#/components/schemas/StateReason" DiskBackupExportMember: type: object properties: exportId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 replicaSetName: type: string description: Human-readable label that identifies the replica set on the sharded cluster. readOnly: true ExportStatus: type: object properties: exportedCollections: type: integer description: Count of collections whose documents were exported to the Export Bucket. format: int32 readOnly: true totalCollections: type: integer description: Total count of collections whose documents will be exported to the Export Bucket. format: int32 readOnly: true description: State of the Export Job. StateReason: type: object properties: errorCode: type: string description: Error code relating to state. message: type: string description: Message describing error or state. description: State reason of the Job. This is set when the job state is "Failed". readOnly: true DiskBackupExportJobRequest: required: - exportBucketId - snapshotId type: object properties: customData: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BackupLabel" exportBucketId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the Export Bucket. writeOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export. writeOnly: true example: 32b6e34b3d91647abb20e7b8 PaginatedApiAtlasDiskBackupExportJobView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/DiskBackupExportJob" totalCount: minimum: 0 type: integer 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 readOnly: true ApiPrivateDownloadDeliveryUrl: type: object properties: deliveryUrl: type: string description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. endpointId: pattern: "^vpce-[0-9a-f]{17}$" type: string description: Unique 22-character alphanumeric string that identifies the private endpoint. example: vpce-3bf78b0ddee411ba1 description: One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint. DiskBackupRestoreMember: type: object properties: downloadUrl: type: string 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 privateDownloadDeliveryUrls: type: array 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.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ApiPrivateDownloadDeliveryUrl" replicaSetName: type: string description: Human-readable label that identifies the replica set on the sharded cluster. readOnly: true DiskBackupSnapshotRestoreJob: required: - deliveryType type: object properties: cancelled: type: boolean description: Flag that indicates whether someone canceled this restore job. readOnly: true components: type: array description: Information on the restore job for each replica set in the sharded cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DiskBackupRestoreMember" deliveryType: type: string description: Human-readable label that categorizes the restore job to create. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - automated - download - pointInTime deliveryUrl: type: array 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"`.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. desiredTimestamp: "$ref": "#/components/schemas/ApiBSONTimestampView" expired: type: boolean description: Flag that indicates whether the restore job expired. readOnly: true expiresAt: type: string 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 failed: type: boolean description: Flag that indicates whether the restore job failed. readOnly: true finishedAt: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the restore job. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" oplogInc: minimum: 1 type: integer 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`.' format: int32 example: 1 oplogTs: minimum: 1199145600 type: integer 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 pointInTimeUTCSeconds: minimum: 1199145600 type: integer 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation privateDownloadDeliveryUrls: type: array 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.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ApiPrivateDownloadDeliveryUrl" snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 targetClusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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. targetGroupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types. example: 32b6e34b3d91647abb20e7b8 timestamp: type: string 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 PaginatedCloudBackupRestoreJobView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" totalCount: minimum: 0 type: integer 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 readOnly: true AdvancedDiskBackupSnapshotSchedulePolicy: type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this backup policy. example: 32b6e34b3d91647abb20e7b8 policyItems: type: array description: List that contains the specifications for one policy. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DiskBackupApiPolicyItem" description: List that contains a document for each backup policy item in the desired backup policy. AutoExportPolicyView: title: export type: object properties: exportBucketId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 frequencyType: type: string description: Human-readable label that indicates the rate at which the export policy item occurs. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - monthly - yearly description: Policy for automatically exporting Cloud Backup Snapshots. DeleteCopiedBackups: type: object properties: cloudProvider: type: string description: Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete. writeOnly: true enum: - AWS - AZURE - GCP regionName: type: string description: Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region'. writeOnly: true externalDocs: description: Cloud Provider Regions url: https://www.mongodb.com/docs/atlas/reference/cloud-providers/ replicationSpecId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array. writeOnly: true 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 zoneId: pattern: "^([a-f0-9]{24})$" type: string 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. writeOnly: true 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 description: Deleted copy setting whose backup copies need to also be deleted. writeOnly: true DiskBackupCopySetting: type: object properties: cloudProvider: type: string description: Human-readable label that identifies the cloud provider that stores the snapshot copy. enum: - AWS - AZURE - GCP frequencies: type: array description: List that describes which types of snapshots to copy. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string enum: - HOURLY - DAILY - WEEKLY - MONTHLY - YEARLY - ON_DEMAND regionName: type: string description: Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region'. externalDocs: description: Cloud Provider Regions url: https://www.mongodb.com/docs/atlas/reference/cloud-providers/ replicationSpecId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the replication object for a 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 Replication Spec 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 shouldCopyOplogs: type: boolean description: Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores. description: Copy setting item in the desired backup policy. DiskBackupSnapshotSchedule: type: object properties: autoExportEnabled: type: boolean description: Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster with the Snapshot you want to return. readOnly: true copySettings: type: array description: List that contains a document for each copy setting item in the desired backup policy. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DiskBackupCopySetting" deleteCopiedBackups: type: array description: List that contains a document for each deleted copy setting whose backup copies you want to delete. writeOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/DeleteCopiedBackups" export: "$ref": "#/components/schemas/AutoExportPolicyView" extraRetentionSettings: type: array description: List that contains a document for each extra retention setting item in the desired backup policy. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ExtraRetentionSetting" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" nextSnapshot: type: string 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 policies: maxItems: 1 type: array description: Rules set for this backup schedule. items: "$ref": "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" referenceHourOfDay: type: integer description: Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot. format: int32 referenceMinuteOfHour: type: integer description: Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot. format: int32 restoreWindowDays: type: integer 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 updateSnapshots: type: boolean description: Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously. writeOnly: true useOrgAndGroupNamesInExportPrefix: type: boolean 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. ExtraRetentionSetting: type: object properties: frequencyType: type: string description: The frequency type for the extra retention settings for the cluster. enum: - HOURLY - DAILY - WEEKLY - MONTHLY - YEARLY - ON_DEMAND retentionDays: type: integer description: The number of extra retention days for the cluster. format: int32 description: extra retention setting item in the desired backup policy. PaginatedCloudBackupShardedClusterSnapshotView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshot" totalCount: minimum: 0 type: integer 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 readOnly: true PaginatedCloudBackupReplicaSetView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/DiskBackupReplicaSet" totalCount: minimum: 0 type: integer 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 readOnly: true DiskBackupOnDemandSnapshotRequest: type: object properties: description: type: string description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status" : "onDemand"`.' links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" retentionInDays: minimum: 1 type: integer description: Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**. format: int32 BackupSnapshotRetention: required: - retentionUnit - retentionValue type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" retentionUnit: type: string description: Quantity of time in which MongoDB Cloud measures snapshot retention. enum: - DAYS - WEEKS - MONTHS - YEARS retentionValue: type: integer 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. format: int32 example: 5 AWSKMSConfiguration: type: object properties: accessKeyID: maxLength: 128 minLength: 16 type: string description: Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK). example: '019dd98d94b4bb778e7552e4' x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation customerMasterKeyID: maxLength: 2048 minLength: 1 type: string description: Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation enabled: type: boolean description: Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`. region: title: AWS 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_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 - AP_SOUTHEAST_5 - AP_SOUTHEAST_7 - MX_CENTRAL_1 - GLOBAL requirePrivateNetworking: type: boolean description: Enable connection to your Amazon Web Services (AWS) Key Management Service (KMS) over private networking. roleId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key. writeOnly: true example: 32b6e34b3d91647abb20e7b8 secretAccessKey: type: string description: Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key. writeOnly: true valid: type: boolean description: Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data. readOnly: true 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/ AzureKeyVault: type: object properties: azureEnvironment: type: string description: Azure environment in which your account credentials reside. enum: - AZURE - AZURE_CHINA clientID: type: string description: Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant. format: uuid x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation enabled: type: boolean description: Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`. keyIdentifier: type: string description: Web address with a unique key that identifies for your Azure Key Vault. example: https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86 keyVaultName: type: string description: Unique string that identifies the Azure Key Vault that contains your key. This field cannot be modified when you enable and set up private endpoint connections to your Azure Key Vault. requirePrivateNetworking: type: boolean description: Enable connection to your Azure Key Vault over private networking. resourceGroupName: type: string 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. secret: type: string description: Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data. writeOnly: true externalDocs: description: Azure Key Vault Secrets url: https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets subscriptionID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation tenantID: type: string description: Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription. format: uuid x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation valid: type: boolean description: Flag that indicates whether the Azure encryption key can encrypt and decrypt data. readOnly: true 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/ EncryptionAtRest: type: object properties: awsKms: "$ref": "#/components/schemas/AWSKMSConfiguration" azureKeyVault: "$ref": "#/components/schemas/AzureKeyVault" enabledForSearchNodes: type: boolean description: Flag that indicates whether Encryption at Rest for Dedicated Search Nodes is enabled in the specified project. googleCloudKms: "$ref": "#/components/schemas/GoogleCloudKMS" GoogleCloudKMS: type: object properties: enabled: type: boolean description: Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`. keyVersionResourceID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation roleId: pattern: "^([a-f0-9]{24})$" type: string 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 serviceAccountKey: type: string 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. writeOnly: true externalDocs: description: Google Cloud Authentication url: https://cloud.google.com/docs/authentication/getting-started valid: type: boolean description: Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data. readOnly: true 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/ BasicDBObject: title: Field type: object additionalProperties: title: Field type: object description: Fields to index for vector search. description: Fields to index for vector search. ClusterSearchIndex: required: - collectionName - database - name type: object properties: collectionName: type: string description: Human-readable label that identifies the collection that contains one or more Atlas Search indexes. database: type: string description: Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. indexID: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this Atlas Search index. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation name: type: string description: Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique. numPartitions: type: integer description: Number of index partitions. Allowed values are [1, 2, 4]. format: int32 default: 1 status: type: string 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. readOnly: true enum: - IN_PROGRESS - STEADY - FAILED - MIGRATING - STALE - PAUSED type: type: string description: Type of the index. Default type is search. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - search - vectorSearch discriminator: propertyName: type mapping: search: "#/components/schemas/SearchIndex" vectorSearch: "#/components/schemas/VectorSearchIndex" SearchIndex: required: - collectionName - database - name type: object allOf: - "$ref": "#/components/schemas/ClusterSearchIndex" - type: object properties: analyzer: type: string 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. externalDocs: description: Atlas Search Analyzers url: https://dochub.mongodb.org/core/analyzers--fts x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation default: lucene.standard 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 analyzers: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" mappings: "$ref": "#/components/schemas/ApiAtlasFTSMappingsViewManual" searchAnalyzer: type: string description: Method applied to identify words when searching this index. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation default: lucene.standard 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 storedSource: type: object 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. 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 synonyms: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/SearchSynonymMappingDefinition" SearchSynonymMappingDefinition: title: Synonym Mapping Definition required: - analyzer - name - source type: object properties: analyzer: type: string description: Specific pre-defined method chosen to apply to the synonyms to be searched. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation 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 name: type: string description: Human-readable label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition. source: "$ref": "#/components/schemas/SynonymSource" description: Synonyms used for this full text index. SynonymSource: required: - collection type: object properties: collection: type: string description: Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms. description: Data set that stores the mapping one or more words map to one or more synonyms of those words. VectorSearchIndex: required: - collectionName - database - name type: object allOf: - "$ref": "#/components/schemas/ClusterSearchIndex" - type: object properties: fields: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BasicDBObject" MeasurementsIndexes: type: object properties: collectionName: type: string description: Human-readable label that identifies the collection. readOnly: true databaseName: type: string description: Human-readable label that identifies the database that the specified MongoDB process serves. readOnly: true end: type: string 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 granularity: type: string description: Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**. readOnly: true enum: - PT1M - PT5M - PT1H - P1D groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. readOnly: true example: 32b6e34b3d91647abb20e7b8 indexIds: type: array description: List that contains the Atlas Search index identifiers. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Unique 24-hexadecimal digit string that identifies the index. indexStatsMeasurements: type: array description: List that contains the Atlas Search index stats measurements. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MetricsMeasurement" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" processId: 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: 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. readOnly: true example: mongodb.example.com:27017 start: type: string 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 MetricDataPoint: type: object properties: timestamp: type: string 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 value: type: number description: Value that comprises this data point. readOnly: true 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`. readOnly: true MetricsMeasurement: type: object properties: dataPoints: type: array 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`. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MetricDataPoint" name: type: string description: Human-readable label of the measurement that this data point covers. readOnly: true units: type: string description: Element used to quantify the measurement. The resource returns units of throughput, storage, and time. readOnly: true enum: - BYTES - BYTES_PER_SECOND - GIGABYTES - GIGABYTES_PER_HOUR - MEGABYTES_PER_SECOND - MICROSECONDS - MILLISECONDS - PERCENT - SCALAR - SCALAR_PER_SECOND CloudSearchMetrics: required: - groupId - processId type: object properties: groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 hardwareMetrics: type: array description: List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/FTSMetric" indexMetrics: type: array description: List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/FTSMetric" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" processId: 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: Hostname and port that identifies the process. readOnly: true example: mongodb.example.com:27017 statusMetrics: type: array description: List that contains all available Atlas Search status metrics when MongoDB Atlas received this request. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/FTSMetric" FTSMetric: required: - metricName - units type: object properties: metricName: type: string description: Human-readable label that identifies this Atlas Search hardware, status, or index measurement. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation 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 units: type: string description: Unit of measurement that applies to this Atlas Search metric. readOnly: true enum: - BYTES - BYTES_PER_SECOND - GIGABYTES - GIGABYTES_PER_HOUR - KILOBYTES - MEGABYTES - MEGABYTES_PER_SECOND - MILLISECONDS - MILLISECONDS_LOGSCALE - PERCENT - SCALAR - SCALAR_PER_SECOND - SECONDS description: Measurement of one Atlas Search status when MongoDB Atlas received this request. readOnly: true MeasurementsNonIndex: type: object properties: end: type: string 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 granularity: type: string description: Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**. readOnly: true enum: - PT1M - PT5M - PT1H - P1D groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. readOnly: true example: 32b6e34b3d91647abb20e7b8 hardwareMeasurements: type: array description: List that contains the Atlas Search hardware measurements. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MetricsMeasurement" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" processId: 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: 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. readOnly: true example: mongodb.example.com:27017 start: type: string 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 statusMeasurements: type: array description: List that contains the Atlas Search status measurements. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MetricsMeasurement" GroupMaintenanceWindow: required: - dayOfWeek type: object properties: autoDeferOnceEnabled: type: boolean description: Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. dayOfWeek: maximum: 7 minimum: 1 type: integer 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 hourOfDay: maximum: 23 minimum: 0 type: integer 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 numberOfDeferrals: type: integer description: Number of times the current maintenance event for this project has been deferred. format: int32 readOnly: true protectedHours: "$ref": "#/components/schemas/ProtectedHours" startASAP: type: boolean 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation timeZoneId: type: string description: Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI. readOnly: true ProtectedHours: type: object properties: endHourOfDay: maximum: 23 minimum: 0 type: integer description: Zero-based integer that represents the end hour of the of the day that the maintenance will not begin in. format: int32 startHourOfDay: maximum: 23 minimum: 0 type: integer description: Zero-based integer that represents the beginning hour of the of the day that the maintenance will not begin in. format: int32 description: Defines the a window where maintenance will not begin within. DataFederationLimit: title: Limits required: - name - value type: object properties: currentUsage: type: integer description: Amount that indicates the current usage of the limit. format: int64 readOnly: true defaultLimit: type: integer description: Default value of the limit. format: int64 readOnly: true maximumLimit: type: integer description: Maximum value of the limit. format: int64 readOnly: true name: type: string description: Human-readable label that identifies the user-managed limit to modify. readOnly: true value: type: integer description: Amount to set the limit to. format: int64 description: Details of user managed limits. discriminator: propertyName: name mapping: atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.networkAccess.entries: "#/components/schemas/DefaultLimit" atlas.project.security.networkAccess.crossRegionEntries: "#/components/schemas/DefaultLimit" atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" DefaultLimit: title: Default Limit required: - name - value type: object properties: currentUsage: type: integer description: Amount that indicates the current usage of the limit. format: int64 readOnly: true defaultLimit: type: integer description: Default value of the limit. format: int64 readOnly: true maximumLimit: type: integer description: Maximum value of the limit. format: int64 readOnly: true name: type: string description: Human-readable label that identifies the user-managed limit to modify. readOnly: true value: type: integer description: Amount to set the limit to. format: int64 description: Details of user managed limits GroupSettings: type: object properties: isCollectDatabaseSpecificsStatisticsEnabled: type: boolean description: Flag that indicates whether to collect database-specific metrics for the specified project. x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation isDataExplorerEnabled: type: boolean description: Flag that indicates whether to enable the Data Explorer for the specified project. x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation isDataExplorerGenAIFeaturesEnabled: type: boolean 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation isDataExplorerGenAISampleDocumentPassingEnabled: type: boolean 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. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation default: false isExtendedStorageSizesEnabled: type: boolean description: Flag that indicates whether to enable extended storage sizes for the specified project. x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation isPerformanceAdvisorEnabled: type: boolean description: Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project. x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation isRealtimePerformancePanelEnabled: type: boolean description: Flag that indicates whether to enable the Real Time Performance Panel for the specified project. x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation isSchemaAdvisorEnabled: type: boolean description: Flag that indicates whether to enable the Schema Advisor for the specified project. x-xgen-IPA-exception: xgen-IPA-112-boolean-field-names-avoid-is-prefix: Schema predates IPA validation description: Collection of settings that configures the project. GroupUpdate: type: object properties: name: type: string description: Human-readable label that identifies the project included in the MongoDB Cloud organization. tags: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" description: Request view to update the group. CustomZoneMappings: type: object properties: customZoneMappings: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ZoneMapping" ZoneMapping: title: Global Cluster Zone required: - location - zone type: object properties: location: type: string 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. zone: type: string description: Human-readable label that identifies the zone in your global cluster. This zone maps to a location code. description: Human-readable label that identifies the subset of a global cluster. AWSCloudProviderSettings: type: object allOf: - "$ref": "#/components/schemas/ClusterProviderSettings" - type: object properties: autoScaling: "$ref": "#/components/schemas/CloudProviderAWSAutoScaling" diskIOPS: type: integer description: Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform. format: int32 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation encryptEBSVolume: type: boolean 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. deprecated: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: true instanceSizeName: title: AWS Instance Sizes type: string description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME regionName: title: AWS 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. externalDocs: description: AWS url: https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws 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 - AP_SOUTHEAST_5 - AP_SOUTHEAST_7 - MX_CENTRAL_1 - GLOBAL volumeType: type: string description: Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title="Amazon Web Services">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters. enum: - STANDARD - PROVISIONED AWSComputeAutoScaling: title: AWS type: object properties: maxInstanceSize: title: AWS Instance Sizes type: string description: Maximum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME minInstanceSize: title: AWS Instance Sizes type: string description: Minimum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M100 - M140 - M200 - M300 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R700 - M40_NVME - M50_NVME - M60_NVME - M80_NVME - M200_NVME - M400_NVME 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. AzureCloudProviderSettings: type: object allOf: - "$ref": "#/components/schemas/ClusterProviderSettings" - type: object properties: autoScaling: "$ref": "#/components/schemas/CloudProviderAzureAutoScaling" diskTypeName: type: string description: Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies. externalDocs: description: Disk type url: https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes enum: - P2 - P3 - P4 - P6 - P10 - P15 - P20 - P30 - P40 - P50 instanceSizeName: title: Azure Instance Sizes type: string description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME regionName: title: Azure Regions type: string description: Microsoft Azure Regions. externalDocs: description: Azure url: https://docs.atlas.mongodb.com/reference/microsoft-azure/ 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 AzureComputeAutoScalingRules: title: Azure type: object properties: maxInstanceSize: title: Azure Instance Sizes type: string description: Maximum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME minInstanceSize: title: Azure Instance Sizes type: string description: Minimum instance size to which your cluster can automatically scale. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M90 - M200 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - M60_NVME - M80_NVME - M200_NVME - M300_NVME - M400_NVME - M600_NVME 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. CloudGCPProviderSettings: type: object allOf: - "$ref": "#/components/schemas/ClusterProviderSettings" - type: object properties: autoScaling: "$ref": "#/components/schemas/CloudProviderGCPAutoScaling" instanceSizeName: title: GCP Instance Sizes type: string description: Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. enum: - M10 - M20 - M30 - M40 - M50 - M60 - M80 - M140 - M200 - M250 - M300 - M400 - R40 - R50 - R60 - R80 - R200 - R300 - R400 - R600 regionName: title: GCP Regions type: string description: Google Compute Regions. externalDocs: description: GCP url: https://docs.atlas.mongodb.com/reference/google-gcp/ 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 CloudProviderAWSAutoScaling: type: object properties: compute: "$ref": "#/components/schemas/AWSComputeAutoScaling" description: Range of instance sizes to which your cluster can scale. CloudProviderAzureAutoScaling: type: object properties: compute: "$ref": "#/components/schemas/AzureComputeAutoScalingRules" description: Range of instance sizes to which your cluster can scale. CloudProviderGCPAutoScaling: type: object properties: compute: "$ref": "#/components/schemas/GCPComputeAutoScaling" description: Range of instance sizes to which your cluster can scale. ClusterAutoScalingSettings: title: Automatic Cluster Scaling Settings type: object properties: compute: "$ref": "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: false description: Range of instance sizes to which your cluster can scale. externalDocs: description: Cluster Auto-Scaling url: https://docs.atlas.mongodb.com/cluster-autoscaling/ ClusterComputeAutoScaling: type: object properties: enabled: type: boolean 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. default: false predictiveEnabled: type: boolean description: |- Flag that indicates whether predictive instance size auto-scaling is enabled. - Set to `true` to enable predictive instance size auto-scaling. MongoDB Cloud requires **autoScaling.compute.enabled** is `true` in order to enable this feature. - Set to `false` to disable predictive instance size auto-scaling. default: false scaleDownEnabled: type: boolean 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**. default: false 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. ClusterFlexProviderSettings: type: object allOf: - "$ref": "#/components/schemas/ClusterProviderSettings" - type: object properties: backingProviderName: type: string 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 instanceSizeName: title: Flex Instance Sizes type: string 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 regionName: type: string 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/). x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one ClusterFreeAutoScaling: type: object properties: compute: "$ref": "#/components/schemas/FreeComputeAutoScalingRules" description: Range of instance sizes to which your cluster can scale. ClusterFreeProviderSettings: type: object allOf: - "$ref": "#/components/schemas/ClusterProviderSettings" - type: object properties: autoScaling: "$ref": "#/components/schemas/ClusterFreeAutoScaling" backingProviderName: type: string 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 createFlexCluster API for such configurations moving forward." externalDocs: description: createFlexCluster API url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster enum: - AWS - GCP - AZURE effectiveInstanceSizeName: type: string description: The true tenant instance size. This is present to support backwards compatibility for deprecated provider types and/or instance sizes. readOnly: true enum: - FLEX - M2 - M5 - M0 instanceSizeName: title: Tenant Instance Sizes type: string 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 regionName: type: string 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}**. x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one ClusterProviderSettings: title: Cloud Service Provider Settings for a Cluster required: - providerName type: object properties: providerName: type: string description: Group of cloud provider settings that configure the provisioned MongoDB hosts. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/AWSCloudProviderSettings" AZURE: "#/components/schemas/AzureCloudProviderSettings" GCP: "#/components/schemas/CloudGCPProviderSettings" TENANT: "#/components/schemas/ClusterFreeProviderSettings" FLEX: "#/components/schemas/ClusterFlexProviderSettings" oneOf: - "$ref": "#/components/schemas/AWSCloudProviderSettings" - "$ref": "#/components/schemas/AzureCloudProviderSettings" - "$ref": "#/components/schemas/CloudGCPProviderSettings" - "$ref": "#/components/schemas/ClusterFreeProviderSettings" - "$ref": "#/components/schemas/ClusterFlexProviderSettings" FreeComputeAutoScalingRules: title: Tenant type: object properties: maxInstanceSize: title: Tenant Instance Sizes type: string description: Maximum instance size to which your cluster can automatically scale. enum: - M0 - M2 - M5 minInstanceSize: title: Tenant Instance Sizes type: string description: Minimum instance size to which your cluster can automatically scale. enum: - M0 - M2 - M5 description: Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. GCPComputeAutoScaling: title: GCP type: object properties: maxInstanceSize: title: GCP Instance Sizes type: string 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 minInstanceSize: title: GCP Instance Sizes type: string 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 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. LegacyAtlasCluster: title: Cluster Description type: object properties: acceptDataRisksAndForceReplicaSetReconfig: type: string 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. format: date-time externalDocs: description: Reconfiguring a Replica Set during a regional outage url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set advancedConfiguration: "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView" autoScaling: "$ref": "#/components/schemas/ClusterAutoScalingSettings" backupEnabled: type: boolean description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. biConnector: "$ref": "#/components/schemas/BiConnector" clusterType: type: string description: Configuration of nodes that comprise the cluster. enum: - REPLICASET - SHARDED - GEOSHARDED configServerManagementMode: type: string 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. externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers default: ATLAS_MANAGED enum: - ATLAS_MANAGED - FIXED_TO_DEDICATED configServerType: type: string description: Describes a sharded cluster's config server type. readOnly: true externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers enum: - DEDICATED - EMBEDDED connectionStrings: "$ref": "#/components/schemas/ClusterConnectionStrings" createDate: type: string 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 diskSizeGB: maximum: 4096 minimum: 10 type: number 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation diskWarmingMode: type: string description: Disk warming mode selection. externalDocs: description: Reduce Secondary Disk Warming Impact url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact default: FULLY_WARMED enum: - FULLY_WARMED - VISIBLE_EARLIER encryptionAtRestProvider: type: string description: 'Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.' externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ enum: - NONE - AWS - AZURE - GCP featureCompatibilityVersion: type: string description: Feature compatibility version of the cluster. readOnly: true featureCompatibilityVersionExpirationDate: type: string description: Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true globalClusterSelfManagedSharding: type: boolean 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 labels: type: array 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 deprecated: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ComponentLabel" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mongoDBEmployeeAccessGrant: "$ref": "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string 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- x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one mongoDBVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of MongoDB that the cluster runs. example: 5.0.25 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongoURI: type: string 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. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongoURIUpdated: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongoURIWithOptions: type: string 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. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster. numShards: maximum: 50 minimum: 1 type: integer 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. format: int32 externalDocs: description: Sharding url: https://docs.mongodb.com/manual/sharding/ default: 1 paused: type: boolean description: Flag that indicates whether the cluster is paused. pitEnabled: type: boolean description: Flag that indicates whether the cluster uses continuous cloud backups. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ providerBackupEnabled: type: boolean 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. providerSettings: "$ref": "#/components/schemas/ClusterProviderSettings" replicaSetScalingStrategy: type: string 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. externalDocs: description: Modify the Replica Set Scaling Mode url: https://dochub.mongodb.org/core/scale-nodes default: WORKLOAD_TYPE enum: - SEQUENTIAL - WORKLOAD_TYPE - NODE_TYPE replicationFactor: type: integer 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. format: int32 deprecated: true default: 3 enum: - 3 - 5 - 7 replicationSpec: title: Region Configuration type: object additionalProperties: "$ref": "#/components/schemas/RegionSpec" description: Physical location where MongoDB Cloud provisions cluster nodes. replicationSpecs: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/LegacyReplicationSpec" rootCertType: type: string description: Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. default: ISRGROOTX1 enum: - ISRGROOTX1 srvAddress: type: string 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. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ stateName: type: string 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. readOnly: true enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING tags: type: array description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" terminationProtectionEnabled: type: boolean 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. default: false versionReleaseSystem: type: string description: Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. default: LTS enum: - LTS - CONTINUOUS description: Group of settings that configure a MongoDB cluster. LegacyRegionsConfig: title: Region Configuration type: object additionalProperties: "$ref": "#/components/schemas/RegionSpec" description: Physical location where MongoDB Cloud provisions cluster nodes. LegacyReplicationSpec: type: object properties: id: pattern: "^([a-f0-9]{24})$" type: string description: |- Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster. - If you include existing zones in the request, you must specify this parameter. - If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request. example: 32b6e34b3d91647abb20e7b8 numShards: type: integer 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 default: 1 regionsConfig: "$ref": "#/components/schemas/LegacyRegionsConfig" zoneName: type: string description: Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`. RegionSpec: title: Region Configuration type: object properties: analyticsNodes: type: integer 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 electableNodes: type: integer 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. format: int32 enum: - 0 - 3 - 5 - 7 priority: maximum: 7 minimum: 0 type: integer 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 readOnlyNodes: type: integer 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 description: Physical location where MongoDB Cloud provisions cluster nodes. PaginatedLegacyClusterView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/LegacyAtlasCluster" totalCount: minimum: 0 type: integer 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 readOnly: true ClusterDescriptionProcessArgs: type: object properties: changeStreamOptionsPreAndPostImagesExpireAfterSeconds: type: integer description: The minimum pre- and post-image retention time in seconds. format: int32 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 default: -1 chunkMigrationConcurrency: type: integer 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. format: int32 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 customOpensslCipherConfigTls12: type: array 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 x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation items: type: string enum: - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 defaultMaxTimeMS: type: integer description: Default time limit in milliseconds for individual read operations to complete. format: int32 externalDocs: description: This option corresponds to the defaultMaxTimeMS cluster parameter. url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation defaultReadConcern: type: string description: |- Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`. externalDocs: description: This option corresponds to the global default read concern. url: https://docs.mongodb.com/manual/reference/read-concern/ x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: available enum: - local - available defaultWriteConcern: type: string 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/ failIndexKeyTooLong: type: boolean description: Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong). externalDocs: description: This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option. url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong deprecated: true x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one default: true javascriptEnabled: type: boolean 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 minimumEnabledTlsProtocol: type: string 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. 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 enum: - TLS1_0 - TLS1_1 - TLS1_2 noTableScan: type: boolean 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 oplogMinRetentionHours: type: number 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. format: double nullable: true 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 oplogSizeMB: type: integer 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. format: int32 nullable: true 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation queryStatsLogVerbosity: type: integer 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. format: int32 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 sampleRefreshIntervalBIConnector: minimum: 0 type: integer description: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. format: int32 externalDocs: description: This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option. url: https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation default: 0 sampleSizeBIConnector: minimum: 0 type: integer description: Number of documents per database to sample when gathering schema information. format: int32 externalDocs: description: This option corresponds to the `sampleSize` `mongosqld` option. url: https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation tlsCipherConfigMode: type: string 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 transactionLifetimeLimitSeconds: minimum: 1 type: integer 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 cleanup process. format: int64 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 LegacyAtlasTenantClusterUpgradeRequest: title: Tenant Cluster Upgrade Request required: - name type: object properties: acceptDataRisksAndForceReplicaSetReconfig: type: string 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. format: date-time externalDocs: description: Reconfiguring a Replica Set during a regional outage url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set advancedConfiguration: "$ref": "#/components/schemas/ApiAtlasClusterAdvancedConfigurationView" autoScaling: "$ref": "#/components/schemas/ClusterAutoScalingSettings" backupEnabled: type: boolean description: Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. biConnector: "$ref": "#/components/schemas/BiConnector" clusterType: type: string description: Configuration of nodes that comprise the cluster. enum: - REPLICASET - SHARDED - GEOSHARDED configServerManagementMode: type: string 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. externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers default: ATLAS_MANAGED enum: - ATLAS_MANAGED - FIXED_TO_DEDICATED configServerType: type: string description: Describes a sharded cluster's config server type. readOnly: true externalDocs: description: MongoDB Sharded Cluster Config Servers url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers enum: - DEDICATED - EMBEDDED connectionStrings: "$ref": "#/components/schemas/ClusterConnectionStrings" createDate: type: string 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 diskSizeGB: maximum: 4096 minimum: 10 type: number 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation diskWarmingMode: type: string description: Disk warming mode selection. externalDocs: description: Reduce Secondary Disk Warming Impact url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact default: FULLY_WARMED enum: - FULLY_WARMED - VISIBLE_EARLIER encryptionAtRestProvider: type: string description: 'Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.' externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ enum: - NONE - AWS - AZURE - GCP featureCompatibilityVersion: type: string description: Feature compatibility version of the cluster. readOnly: true featureCompatibilityVersionExpirationDate: type: string description: Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true globalClusterSelfManagedSharding: type: boolean 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 labels: type: array 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 deprecated: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ComponentLabel" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mongoDBEmployeeAccessGrant: "$ref": "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string 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- x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one mongoDBVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of MongoDB that the cluster runs. example: 5.0.25 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongoURI: type: string 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. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongoURIUpdated: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongoURIWithOptions: type: string 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. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster. numShards: maximum: 50 minimum: 1 type: integer 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. format: int32 externalDocs: description: Sharding url: https://docs.mongodb.com/manual/sharding/ default: 1 paused: type: boolean description: Flag that indicates whether the cluster is paused. pitEnabled: type: boolean description: Flag that indicates whether the cluster uses continuous cloud backups. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ providerBackupEnabled: type: boolean 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. providerSettings: "$ref": "#/components/schemas/ClusterProviderSettings" replicaSetScalingStrategy: type: string 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. externalDocs: description: Modify the Replica Set Scaling Mode url: https://dochub.mongodb.org/core/scale-nodes default: WORKLOAD_TYPE enum: - SEQUENTIAL - WORKLOAD_TYPE - NODE_TYPE replicationFactor: type: integer 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. format: int32 deprecated: true default: 3 enum: - 3 - 5 - 7 replicationSpec: title: Region Configuration type: object additionalProperties: "$ref": "#/components/schemas/RegionSpec" description: Physical location where MongoDB Cloud provisions cluster nodes. replicationSpecs: type: array 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. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/LegacyReplicationSpec" rootCertType: type: string description: Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. default: ISRGROOTX1 enum: - ISRGROOTX1 srvAddress: type: string 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. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ stateName: type: string 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. readOnly: true enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING tags: type: array description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. externalDocs: description: Resource Tags url: https://dochub.mongodb.org/core/add-cluster-tag-atlas x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" terminationProtectionEnabled: type: boolean 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. default: false versionReleaseSystem: type: string description: Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. default: LTS enum: - LTS - CONTINUOUS description: Request containing target state of tenant cluster to be upgraded ClusterServerlessBackupOptions: title: Serverless Backup Options type: object properties: serverlessContinuousBackupEnabled: type: boolean 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. | x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one default: true description: Group of settings that configure serverless backup. ServerlessConnectionStringsPrivateEndpointItem: title: Serverless Instance Private Endpoint Connection Strings Endpoint type: object properties: endpointId: type: string description: Unique string that the cloud provider uses to identify the private endpoint. readOnly: true providerName: type: string description: Cloud provider where the private endpoint is deployed. readOnly: true enum: - AWS - AZURE region: type: string description: Region where the private endpoint is deployed. readOnly: true description: Details of a private endpoint deployed for this serverless instance. ServerlessConnectionStringsPrivateEndpointList: title: Serverless Instance Private Endpoint Connection String type: object properties: endpoints: type: array description: List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" srvConnectionString: type: string 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: type: string description: MongoDB process type to which your application connects. readOnly: true enum: - MONGOS 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/ ServerlessInstanceDescription: title: Serverless Instance Description required: - providerSettings type: object properties: connectionStrings: "$ref": "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" createDate: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the serverless instance. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mongoDBVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of MongoDB that the serverless instance runs. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the serverless instance. providerSettings: "$ref": "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: "$ref": "#/components/schemas/ClusterServerlessBackupOptions" stateName: type: string 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. readOnly: true enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING tags: type: array description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" terminationProtectionEnabled: type: boolean 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. default: false description: Group of settings that configure a MongoDB serverless instance. ServerlessInstanceDescriptionConnectionStrings: title: Serverless Instance Connection Strings type: object properties: privateEndpoint: type: array 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. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" standardSrv: type: string description: Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol. readOnly: true externalDocs: description: Connection String URI Format url: https://docs.mongodb.com/manual/reference/connection-string/ description: Collection of Uniform Resource Locators that point to the MongoDB database. readOnly: true externalDocs: description: Connection string URI format. url: https://docs.mongodb.com/manual/reference/connection-string/ ServerlessProviderSettings: title: Cloud Service Provider Settings for a Serverless Instance required: - backingProviderName - regionName type: object properties: backingProviderName: type: string description: Cloud service provider on which MongoDB Cloud provisioned the serverless instance. enum: - AWS - AZURE - GCP effectiveDiskSizeGBLimit: type: integer 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation effectiveInstanceSizeName: "$ref": "#/components/schemas/BaseCloudProviderInstanceSize" effectiveProviderName: type: string description: Cloud service provider on which MongoDB Cloud effectively provisioned the serverless instance. readOnly: true providerName: type: string description: Human-readable label that identifies the cloud service provider. default: SERVERLESS enum: - SERVERLESS regionName: type: string 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/). x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one description: Group of cloud provider settings that configure the provisioned MongoDB serverless instance. ServerlessInstanceDescriptionCreate: title: Serverless Instance Description Create required: - name - providerSettings type: object properties: name: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the serverless instance. writeOnly: true providerSettings: "$ref": "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: "$ref": "#/components/schemas/ClusterServerlessBackupOptions" stateName: type: string 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. readOnly: true enum: - IDLE - CREATING - UPDATING - DELETING - REPAIRING tags: type: array description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" terminationProtectionEnabled: type: boolean 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. default: false description: Settings that you can specify when you create a serverless instance. PaginatedServerlessInstanceDescriptionView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ServerlessInstanceDescription" totalCount: minimum: 0 type: integer 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 readOnly: true ServerlessInstanceDescriptionUpdate: title: Serverless Instance Description Update type: object properties: serverlessBackupOptions: "$ref": "#/components/schemas/ClusterServerlessBackupOptions" tags: type: array description: List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/ResourceTag" terminationProtectionEnabled: type: boolean 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. default: false description: Settings that you can update when you request a serverless cluster update. MongoDBAccessLogs: type: object properties: authResult: type: boolean description: Flag that indicates whether the response should return successful authentication attempts only. authSource: type: string description: Database against which someone attempted to authenticate. readOnly: true failureReason: type: string description: Reason that the authentication failed. Null if authentication succeeded. readOnly: true groupId: type: string description: Unique 24-hexadecimal character string that identifies the project. readOnly: true hostname: type: string description: Human-readable label that identifies the hostname of the target node that received the authentication attempt. readOnly: true ipAddress: 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: Internet Protocol address that attempted to authenticate with the database. readOnly: true logLine: type: string description: Text of the host log concerning the authentication attempt. readOnly: true timestamp: type: string description: Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true username: type: string description: Username used to authenticate against the database. readOnly: true description: Authentication attempt, one per object, made against the cluster. MongoDBAccessLogsList: type: object properties: accessLogs: type: array description: Authentication attempt, one per object, made against the cluster. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MongoDBAccessLogs" NetworkPermissionEntry: type: object properties: awsSecurityGroup: pattern: "^([0-9]*/)?sg-([0-9]*)" type: string 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**. cidrBlock: 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: 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**. comment: maxLength: 80 type: string description: Remark that explains the purpose or scope of this IP access list entry. deleteAfterDate: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string 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. readOnly: true example: 32b6e34b3d91647abb20e7b8 ipAddress: 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: 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**. links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" PaginatedNetworkAccessView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/NetworkPermissionEntry" totalCount: minimum: 0 type: integer 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 readOnly: true NetworkPermissionEntryStatus: required: - STATUS type: object properties: STATUS: type: string 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. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation enum: - PENDING - FAILED - ACTIVE AWSDataProcessRegionView: type: object allOf: - "$ref": "#/components/schemas/DataProcessRegionView" - type: object properties: region: type: string description: Human-readable label that identifies the geographic location of the region where you store your archived data. readOnly: true 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 AzureDataProcessRegionView: type: object allOf: - "$ref": "#/components/schemas/DataProcessRegionView" - type: object properties: region: type: string description: Human-readable label that identifies the geographic location of the region where you store your archived data. readOnly: true enum: - US_EAST_2 - EUROPE_WEST - BRAZIL_SOUTH BackupOnlineArchive: type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the online archive. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive. readOnly: true collName: type: string description: Human-readable label that identifies the collection for which you created the online archive. readOnly: true collectionType: type: string 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"`. readOnly: true default: STANDARD enum: - TIMESERIES - STANDARD criteria: "$ref": "#/components/schemas/CriteriaView" dataExpirationRule: "$ref": "#/components/schemas/DataExpirationRuleView" dataProcessRegion: "$ref": "#/components/schemas/DataProcessRegionView" dataSetName: type: string description: Human-readable label that identifies the dataset that Atlas generates for this online archive. readOnly: true dbName: type: string description: Human-readable label of the database that contains the collection that contains the online archive. readOnly: true groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive. readOnly: true example: 32b6e34b3d91647abb20e7b8 partitionFields: minItems: 1 type: array description: 'List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you "specified :criteria.type": "DATE" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you "specified :criteria.type": "CUSTOM" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don''t use ":criteria.type": "DATE" or ":criteria.type": "CUSTOM" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PartitionFieldView" paused: type: boolean description: Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**. schedule: "$ref": "#/components/schemas/OnlineArchiveSchedule" state: type: string description: |- Phase of the process to create this online archive when you made this request. | State | Indication | |-------------|------------| | `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. | | `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. | | `IDLE` | MongoDB Cloud waits to start the next archival job. | | `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. | | `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. | | `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. | | `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. | readOnly: true x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation enum: - PENDING - ACTIVE - PAUSING - PAUSED - DELETED - ORPHANED CriteriaView: type: object properties: type: type: string 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 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: propertyName: type mapping: DATE: "#/components/schemas/DateCriteriaView" CUSTOM: "#/components/schemas/CustomCriteriaView" CustomCriteriaView: title: Archival Criteria required: - query type: object description: "**CUSTOM criteria.type**." allOf: - "$ref": "#/components/schemas/CriteriaView" - type: object properties: query: type: string 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"**.' DailyScheduleView: required: - type type: object allOf: - "$ref": "#/components/schemas/OnlineArchiveSchedule" - type: object properties: endHour: maximum: 23 minimum: 0 type: integer description: Hour of the day when the scheduled window to run one online archive ends. format: int32 endMinute: maximum: 59 minimum: 0 type: integer description: Minute of the hour when the scheduled window to run one online archive ends. format: int32 startHour: maximum: 23 minimum: 0 type: integer description: Hour of the day when the when the scheduled window to run one online archive starts. format: int32 startMinute: maximum: 59 minimum: 0 type: integer description: Minute of the hour when the scheduled window to run one online archive starts. format: int32 DataExpirationRuleView: type: object properties: expireAfterDays: maximum: 9215 minimum: 7 type: integer description: Number of days used in the date criteria for nominating documents for deletion. format: int32 description: Rule for specifying when data should be deleted from the archive. DataProcessRegionView: type: object properties: cloudProvider: type: string description: Human-readable label that identifies the Cloud service provider where you store your archived data. readOnly: true enum: - AWS - AZURE - GCP description: Settings to configure the region where you wish to store your archived data. readOnly: true discriminator: propertyName: cloudProvider mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" GCP: "#/components/schemas/GCPDataProcessRegionView" DateCriteriaView: title: Archival Criteria type: object description: "**DATE criteria.type**." allOf: - "$ref": "#/components/schemas/CriteriaView" - type: object properties: dateField: type: string 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"`.' dateFormat: type: string 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 ObjectId. 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"**. default: ISODATE enum: - ISODATE - EPOCH_SECONDS - EPOCH_MILLIS - EPOCH_NANOSECONDS - OBJECT_ID expireAfterDays: type: integer 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 DefaultScheduleView: required: - type type: object allOf: - "$ref": "#/components/schemas/OnlineArchiveSchedule" GCPDataProcessRegionView: type: object allOf: - "$ref": "#/components/schemas/DataProcessRegionView" - type: object properties: region: type: string description: Human-readable label that identifies the geographic location of the region where you store your archived data. readOnly: true enum: - CENTRAL_US - WESTERN_EUROPE MonthlyScheduleView: required: - type type: object allOf: - "$ref": "#/components/schemas/OnlineArchiveSchedule" - type: object properties: dayOfMonth: maximum: 31 minimum: 1 type: integer description: Day of the month when the scheduled archive starts. format: int32 endHour: maximum: 23 minimum: 0 type: integer description: Hour of the day when the scheduled window to run one online archive ends. format: int32 endMinute: maximum: 59 minimum: 0 type: integer description: Minute of the hour when the scheduled window to run one online archive ends. format: int32 startHour: maximum: 23 minimum: 0 type: integer description: Hour of the day when the when the scheduled window to run one online archive starts. format: int32 startMinute: maximum: 59 minimum: 0 type: integer description: Minute of the hour when the scheduled window to run one online archive starts. format: int32 OnlineArchiveSchedule: title: Online Archive Schedule required: - type type: object properties: type: type: string description: Type of schedule. enum: - DEFAULT - DAILY - WEEKLY - MONTHLY description: Regular frequency and duration when archiving process occurs. discriminator: propertyName: type mapping: DEFAULT: "#/components/schemas/DefaultScheduleView" DAILY: "#/components/schemas/DailyScheduleView" WEEKLY: "#/components/schemas/WeeklyScheduleView" MONTHLY: "#/components/schemas/MonthlyScheduleView" oneOf: - "$ref": "#/components/schemas/DefaultScheduleView" - "$ref": "#/components/schemas/DailyScheduleView" - "$ref": "#/components/schemas/WeeklyScheduleView" - "$ref": "#/components/schemas/MonthlyScheduleView" PartitionFieldView: title: Online Archive Partition required: - fieldName - order type: object properties: fieldName: maxLength: 700 type: string description: Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation. fieldType: type: string 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. readOnly: true externalDocs: description: UUID url: http://bsonspec.org/spec.html x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - date - int - long - objectId - string - uuid order: type: integer 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 default: 0 description: Metadata to partition this online archive. WeeklyScheduleView: required: - type type: object allOf: - "$ref": "#/components/schemas/OnlineArchiveSchedule" - type: object properties: dayOfWeek: maximum: 7 minimum: 1 type: integer description: Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`). format: int32 endHour: maximum: 23 minimum: 0 type: integer description: Hour of the day when the scheduled window to run one online archive ends. format: int32 endMinute: maximum: 59 minimum: 0 type: integer description: Minute of the hour when the scheduled window to run one online archive ends. format: int32 startHour: maximum: 23 minimum: 0 type: integer description: Hour of the day when the when the scheduled window to run one online archive starts. format: int32 startMinute: maximum: 59 minimum: 0 type: integer description: Minute of the hour when the scheduled window to run one online archive starts. format: int32 AWSCreateDataProcessRegionView: type: object allOf: - "$ref": "#/components/schemas/CreateDataProcessRegionView" - type: object properties: region: type: string description: Human-readable label that identifies the geographic location of the region where you wish to store your archived data. enum: - US_EAST_1 - US_WEST_2 - SA_EAST_1 - EU_WEST_1 - EU_WEST_2 - EU_CENTRAL_1 - AP_SOUTH_1 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 - AP_NORTHEAST_2 AzureCreateDataProcessRegionView: type: object allOf: - "$ref": "#/components/schemas/CreateDataProcessRegionView" - type: object properties: region: type: string description: Human-readable label that identifies the geographic location of the region where you wish to store your archived data. enum: - US_EAST_2 - EUROPE_WEST - BRAZIL_SOUTH BackupOnlineArchiveCreate: required: - collName - criteria - dbName type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the online archive. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive. readOnly: true collName: type: string description: Human-readable label that identifies the collection for which you created the online archive. writeOnly: true collectionType: type: string 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"`. writeOnly: true default: STANDARD enum: - TIMESERIES - STANDARD criteria: "$ref": "#/components/schemas/CriteriaView" dataExpirationRule: "$ref": "#/components/schemas/DataExpirationRuleView" dataProcessRegion: "$ref": "#/components/schemas/CreateDataProcessRegionView" dataSetName: type: string description: Human-readable label that identifies the dataset that Atlas generates for this online archive. readOnly: true dbName: type: string description: Human-readable label of the database that contains the collection that contains the online archive. writeOnly: true groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive. readOnly: true example: 32b6e34b3d91647abb20e7b8 partitionFields: minItems: 1 type: array description: 'List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you "specified :criteria.type": "DATE" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you "specified :criteria.type": "CUSTOM" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don''t use ":criteria.type": "DATE" or ":criteria.type": "CUSTOM" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.' writeOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PartitionFieldView" paused: type: boolean description: Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**. schedule: "$ref": "#/components/schemas/OnlineArchiveSchedule" state: type: string description: |- Phase of the process to create this online archive when you made this request. | State | Indication | |-------------|------------| | `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. | | `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. | | `IDLE` | MongoDB Cloud waits to start the next archival job. | | `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. | | `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. | | `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. | | `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. | readOnly: true x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-tables: Description predates IPA validation enum: - PENDING - ACTIVE - PAUSING - PAUSED - DELETED - ORPHANED CreateDataProcessRegionView: type: object properties: cloudProvider: type: string 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 description: Settings to configure the region where you wish to store your archived data. writeOnly: true discriminator: propertyName: cloudProvider mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" GCP: "#/components/schemas/GCPCreateDataProcessRegionView" GCPCreateDataProcessRegionView: type: object allOf: - "$ref": "#/components/schemas/CreateDataProcessRegionView" - type: object properties: region: type: string description: Human-readable label that identifies the geographic location of the region where you wish to store your archived data. enum: - CENTRAL_US - WESTERN_EUROPE PaginatedOnlineArchiveView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BackupOnlineArchive" totalCount: minimum: 0 type: integer 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 readOnly: true AwsNetworkPeeringConnectionSettings: title: AWS required: - accepterRegionName - awsAccountId - containerId - routeTableCidrBlock - vpcId type: object properties: accepterRegionName: type: string description: Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region. awsAccountId: pattern: "^[0-9]{12}$" type: string description: Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. connectionId: type: string description: Unique string that identifies the peering connection on AWS. readOnly: true containerId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. example: 32b6e34b3d91647abb20e7b8 errorStateName: type: string description: Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded. readOnly: true enum: - REJECTED - EXPIRED - INVALID_ARGUMENT id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the network peering connection. readOnly: true example: 32b6e34b3d91647abb20e7b8 providerName: type: string description: Cloud service provider that serves the requested network peering connection. enum: - AWS - AZURE - GCP routeTableCidrBlock: 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: 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. statusName: type: string description: State of the network peering connection at the time you made the request. readOnly: true enum: - INITIATING - PENDING_ACCEPTANCE - FAILED - FINALIZING - AVAILABLE - TERMINATING vpcId: pattern: "^vpc-[0-9a-f]{17}$" type: string description: Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. description: Group of Network Peering connection settings. AzureNetworkPeeringConnectionSettings: title: AZURE required: - azureDirectoryId - azureSubscriptionId - containerId - resourceGroupName - vnetName type: object properties: azureDirectoryId: type: string description: Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides. format: uuid azureSubscriptionId: type: string description: Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides. format: uuid containerId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. example: 32b6e34b3d91647abb20e7b8 errorState: type: string description: 'Error message returned when a requested Azure network peering resource returns `"status" : "FAILED"`. The resource returns `null` if the request succeeded.' readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the network peering connection. readOnly: true example: 32b6e34b3d91647abb20e7b8 providerName: type: string description: Cloud service provider that serves the requested network peering connection. enum: - AWS - AZURE - GCP resourceGroupName: pattern: "^([-\\w._()])+$" type: string description: Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides. status: type: string description: State of the network peering connection at the time you made the request. readOnly: true enum: - ADDING_PEER - AVAILABLE - FAILED - DELETION_FAILED - DELETING vnetName: pattern: "^([-\\w._()])$" type: string description: Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet. description: Group of Network Peering connection settings. BaseNetworkPeeringConnectionSettings: required: - containerId type: object properties: containerId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the network peering connection. readOnly: true example: 32b6e34b3d91647abb20e7b8 providerName: type: string description: Cloud service provider that serves the requested network peering connection. enum: - AWS - AZURE - GCP discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/AwsNetworkPeeringConnectionSettings" AZURE: "#/components/schemas/AzureNetworkPeeringConnectionSettings" GCP: "#/components/schemas/GCPNetworkPeeringConnectionSettings" oneOf: - "$ref": "#/components/schemas/AwsNetworkPeeringConnectionSettings" - "$ref": "#/components/schemas/AzureNetworkPeeringConnectionSettings" - "$ref": "#/components/schemas/GCPNetworkPeeringConnectionSettings" GCPNetworkPeeringConnectionSettings: title: GCP required: - containerId - gcpProjectId - networkName type: object properties: containerId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. example: 32b6e34b3d91647abb20e7b8 errorMessage: type: string description: Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded. readOnly: true gcpProjectId: pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" type: string description: Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC. id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the network peering connection. readOnly: true example: 32b6e34b3d91647abb20e7b8 networkName: pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" type: string description: Human-readable label that identifies the network to peer with the MongoDB Cloud VPC. providerName: type: string description: Cloud service provider that serves the requested network peering connection. enum: - AWS - AZURE - GCP status: type: string description: State of the network peering connection at the time you made the request. readOnly: true enum: - ADDING_PEER - WAITING_FOR_USER - AVAILABLE - FAILED - DELETING description: Group of Network Peering connection settings. PaginatedContainerPeerView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" totalCount: minimum: 0 type: integer 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 readOnly: true description: Group of Network Peering connection settings. NamespaceObj: type: object properties: namespace: type: string description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. readOnly: true type: type: string description: Human-readable label that identifies the type of namespace. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: collection enum: - collection description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. readOnly: true Namespaces: type: object properties: namespaces: uniqueItems: true type: array description: List that contains each combination of database, collection, and type on the specified host. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/NamespaceObj" PerformanceAdvisorSlowQuery: type: object properties: line: type: string description: Text of the MongoDB log related to this slow query. readOnly: true metrics: "$ref": "#/components/schemas/PerformanceAdvisorSlowQueryMetrics" namespace: type: string description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. readOnly: true opType: type: string description: Operation type (read/write/command) associated with this slow query log. readOnly: true replicaState: type: string description: Replica state associated with this slow query log. readOnly: true description: Details of one slow query that the Performance Advisor detected. readOnly: true PerformanceAdvisorSlowQueryList: type: object properties: slowQueries: type: array description: List of operations that the Performance Advisor detected that took longer to execute than a specified threshold. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PerformanceAdvisorSlowQuery" PerformanceAdvisorSlowQueryMetrics: type: object properties: docsExamined: type: integer description: The number of documents in the collection that MongoDB scanned in order to carry out the operation. format: int64 readOnly: true docsExaminedReturnedRatio: type: number description: Ratio of documents examined to documents returned. format: double readOnly: true docsReturned: type: integer description: The number of documents returned by the operation. format: int64 readOnly: true fromUserConnection: type: boolean description: This boolean will be true when the server can identfiy the query source as non-server. This field is only available for MDB 8.0+. readOnly: true hasIndexCoverage: type: boolean description: Indicates if the query has index coverage. readOnly: true hasSort: type: boolean 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 keysExamined: type: integer description: The number of index keys that MongoDB scanned in order to carry out the operation. format: int64 readOnly: true keysExaminedReturnedRatio: type: number description: Ratio of keys examined to documents returned. format: double readOnly: true numYields: type: integer description: The number of times the operation yielded to allow other operations to complete. format: int64 readOnly: true operationExecutionTime: type: integer description: Total execution time of a query in milliseconds. format: int64 readOnly: true responseLength: type: integer description: The length in bytes of the operation's result document. format: int64 readOnly: true description: Metrics from a slow query log. readOnly: true BasicBSONList: type: array description: List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values. readOnly: true x-xgen-IPA-exception: xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: object description: List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values. readOnly: true x-xgen-IPA-exception: xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation xgen-IPA-124-array-max-items: Schema predates IPA validation PerformanceAdvisorIndex: type: object properties: avgObjSize: type: number description: The average size of an object in the collection of this index. format: double readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this index. readOnly: true example: 32b6e34b3d91647abb20e7b8 impact: type: array description: List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: One unique 24-hexadecimal character string that identifies one query shape. index: type: array description: List that contains documents that specify a key in the index and its sort order. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: object additionalProperties: 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. format: int32 enum: - 1 - -1 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. namespace: type: string description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. readOnly: true weight: type: number description: Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface. format: double readOnly: true PerformanceAdvisorOpStats: type: object properties: ms: type: integer 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 nReturned: type: integer description: Number of results that the query returns. format: int64 readOnly: true nScanned: type: integer description: Number of documents that the query read. format: int64 readOnly: true ts: type: integer 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. format: int64 readOnly: true externalDocs: description: UNIX Epoch url: https://en.wikipedia.org/wiki/Unix_time description: Details that this resource returned about the specified query. readOnly: true PerformanceAdvisorOperationView: type: object properties: predicates: type: array description: List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values. readOnly: true x-xgen-IPA-exception: xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: object description: List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values. readOnly: true x-xgen-IPA-exception: xgen-IPA-117-objects-must-be-well-defined: Schema predates IPA validation xgen-IPA-124-array-max-items: Schema predates IPA validation stats: "$ref": "#/components/schemas/PerformanceAdvisorOpStats" PerformanceAdvisorResponse: type: object properties: shapes: type: array description: List of query predicates, sorts, and projections that the Performance Advisor suggests. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PerformanceAdvisorShape" suggestedIndexes: type: array description: List that contains the documents with information about the indexes that the Performance Advisor suggests. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PerformanceAdvisorIndex" PerformanceAdvisorShape: type: object properties: avgMs: type: integer description: Average duration in milliseconds for the queries examined that match this shape. format: int64 readOnly: true count: type: integer description: Number of queries examined that match this shape. format: int64 readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request. readOnly: true example: 32b6e34b3d91647abb20e7b8 inefficiencyScore: type: integer description: Average number of documents read for every document that the query returns. format: int64 readOnly: true externalDocs: description: Understanding the Query Inefficiency Score url: https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score namespace: type: string description: Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`. readOnly: true operations: type: array description: List that contains specific about individual queries. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/PerformanceAdvisorOperationView" AWSPrivateLinkConnection: title: AWS required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint service. readOnly: true enum: - AWS - AZURE - GCP endpointServiceName: pattern: "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}" type: string description: Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. readOnly: true errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. readOnly: true example: 32b6e34b3d91647abb20e7b8 interfaceEndpoints: type: array description: List of strings that identify private endpoint interfaces applied to the specified project. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the interface endpoint. readOnly: true example: 32b6e34b3d91647abb20e7b8 regionName: type: string description: Cloud provider region that manages this Private Endpoint Service. readOnly: true status: type: string description: State of the Private Endpoint Service connection when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - AVAILABLE - WAITING_FOR_USER - FAILED - DELETING description: Group of Private Endpoint Service settings. AzurePrivateLinkConnection: title: AZURE required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint service. readOnly: true enum: - AWS - AZURE - GCP errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. readOnly: true example: 32b6e34b3d91647abb20e7b8 privateEndpoints: type: array description: List of private endpoints assigned to this Azure Private Link Service. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: 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._()]+)" type: string description: Root-relative path to one private endpoint assigned to this Azure Private Link Service. readOnly: true privateLinkServiceName: pattern: "^pls_[0-9a-f]{24}$" type: string description: Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages. readOnly: true privateLinkServiceResourceId: type: string description: Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet. readOnly: true example: "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de" regionName: type: string description: Cloud provider region that manages this Private Endpoint Service. readOnly: true status: type: string description: State of the Private Endpoint Service connection when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - AVAILABLE - WAITING_FOR_USER - FAILED - DELETING description: Group of Private Endpoint Service settings. EndpointService: required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint service. readOnly: true enum: - AWS - AZURE - GCP errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. readOnly: true example: 32b6e34b3d91647abb20e7b8 regionName: type: string description: Cloud provider region that manages this Private Endpoint Service. readOnly: true status: type: string description: State of the Private Endpoint Service connection when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - AVAILABLE - WAITING_FOR_USER - FAILED - DELETING discriminator: propertyName: cloudProvider mapping: AWS: "#/components/schemas/AWSPrivateLinkConnection" AZURE: "#/components/schemas/AzurePrivateLinkConnection" GCP: "#/components/schemas/GCPEndpointService" GCPEndpointService: title: GCP required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint service. readOnly: true enum: - AWS - AZURE - GCP endpointGroupNames: type: array description: List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service. externalDocs: description: Google Cloud Forwarding Rule Concepts url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service. errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. readOnly: true example: 32b6e34b3d91647abb20e7b8 regionName: type: string description: Cloud provider region that manages this Private Endpoint Service. readOnly: true serviceAttachmentNames: type: array 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. externalDocs: description: Google Cloud Private Service Connect Service Attachments url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: 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 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. status: type: string description: State of the Private Endpoint Service connection when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - AVAILABLE - WAITING_FOR_USER - FAILED - DELETING description: Group of Private Endpoint Service settings. CloudProviderEndpointServiceRequest: required: - providerName - region type: object properties: providerName: type: string description: Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service. writeOnly: true enum: - AWS - AZURE - GCP region: type: string 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/). writeOnly: true x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one AWSInterfaceEndpoint: title: AWS required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint. readOnly: true enum: - AWS - AZURE - GCP connectionStatus: type: string description: State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request. readOnly: true enum: - PENDING_ACCEPTANCE - PENDING - AVAILABLE - REJECTED - DELETING deleteRequested: type: boolean description: Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. readOnly: true errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true interfaceEndpointId: type: string description: Unique 24-hexadecimal digit string that identifies the interface endpoint. readOnly: true description: Group of Private Endpoint settings. AzurePrivateEndpoint: title: AZURE required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint. readOnly: true enum: - AWS - AZURE - GCP deleteRequested: type: boolean description: Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. readOnly: true errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true privateEndpointConnectionName: 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._()]+)" type: string description: Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection. readOnly: true privateEndpointIPAddress: 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: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation privateEndpointResourceId: type: string description: Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service. readOnly: true example: "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln" status: type: string description: State of the Azure Private Link Service connection when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - AVAILABLE - FAILED - DELETING description: Group of Private Endpoint settings. GCPConsumerForwardingRule: type: object properties: endpointName: type: string description: Human-readable label that identifies the Google Cloud consumer forwarding rule that you created. readOnly: true externalDocs: description: Google Cloud Forwarding Rule Concepts url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts ipAddress: 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: One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves. readOnly: true status: type: string description: State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - AVAILABLE - FAILED - DELETING PrivateGCPEndpointGroup: title: GCP required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint. readOnly: true enum: - AWS - AZURE - GCP deleteRequested: type: boolean description: Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. readOnly: true endpointGroupName: type: string description: Human-readable label that identifies a set of endpoints. readOnly: true externalDocs: description: Google Cloud Forwarding Rule Concepts url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts endpoints: type: array description: List of individual private endpoints that comprise this endpoint group. readOnly: true externalDocs: description: Google Cloud Forwarding Rule Concepts url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/GCPConsumerForwardingRule" errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true status: type: string description: State of the Google Cloud network endpoint group when MongoDB Cloud received this request. readOnly: true enum: - INITIATING - VERIFIED - AVAILABLE - FAILED - DELETING description: Group of Private Endpoint settings. PrivateLinkEndpoint: required: - cloudProvider type: object properties: cloudProvider: type: string description: Cloud service provider that serves the requested endpoint. readOnly: true enum: - AWS - AZURE - GCP deleteRequested: type: boolean description: Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. readOnly: true errorMessage: type: string description: Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. readOnly: true discriminator: propertyName: cloudProvider mapping: AWS: "#/components/schemas/AWSInterfaceEndpoint" GCP: "#/components/schemas/PrivateGCPEndpointGroup" AZURE: "#/components/schemas/AzurePrivateEndpoint" CreateAWSEndpointRequest: title: AWS required: - id type: object description: Group of Private Endpoint settings. allOf: - "$ref": "#/components/schemas/CreateEndpointRequest" - type: object properties: id: pattern: "^vpce-[0-9a-f]{17}$" type: string description: Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. writeOnly: true example: vpce-3bf78b0ddee411ba1 CreateAzureEndpointRequest: title: AZURE required: - id - privateEndpointIPAddress type: object description: Group of Private Endpoint settings. allOf: - "$ref": "#/components/schemas/CreateEndpointRequest" - type: object properties: id: type: string description: Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. writeOnly: true example: "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln" privateEndpointIPAddress: 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: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation CreateEndpointRequest: type: object x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/CreateAWSEndpointRequest" - "$ref": "#/components/schemas/CreateAzureEndpointRequest" - "$ref": "#/components/schemas/CreateGCPEndpointGroupRequest" CreateGCPEndpointGroupRequest: title: GCP required: - endpointGroupName - gcpProjectId type: object description: Group of Private Endpoint settings. allOf: - "$ref": "#/components/schemas/CreateEndpointRequest" - type: object properties: endpointGroupName: type: string description: Human-readable label that identifies a set of endpoints. writeOnly: true endpoints: type: array description: List of individual private endpoints that comprise this endpoint group. externalDocs: description: Google Cloud Forwarding Rule Concepts url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/CreateGCPForwardingRuleRequest" gcpProjectId: pattern: "^p-[0-9a-z]{24}$" type: string description: Unique string that identifies the Google Cloud project in which you created the endpoints. writeOnly: true example: p-fdeeb3e43b8e733e5ab627b1 externalDocs: description: Google Cloud Creating and Managing Projects url: https://cloud.google.com/resource-manager/docs/creating-managing-projects CreateGCPForwardingRuleRequest: title: GCP Forwarding Rules type: object properties: endpointName: type: string description: Human-readable label that identifies the Google Cloud consumer forwarding rule that you created. writeOnly: true externalDocs: description: Google Cloud Forwarding Rule Concepts url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts ipAddress: 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: One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves. writeOnly: true ProjectSettingItemView: required: - enabled type: object properties: enabled: type: boolean 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. PrivateIPModeView: required: - enabled type: object properties: enabled: type: boolean description: Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project. PaginatedPrivateNetworkEndpointIdEntryView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry" totalCount: minimum: 0 type: integer 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 readOnly: true PrivateNetworkEndpointIdEntry: required: - endpointId type: object properties: azureLinkId: type: string description: Link ID that identifies the Azure private endpoint connection. comment: type: string description: Human-readable string to associate with this private endpoint. customerEndpointDNSName: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. If defined, you must also specify a value for **region**. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation customerEndpointIPAddress: 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: IP address used to connect to the Azure private endpoint. x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation endpointId: pattern: "^vpce-[0-9a-f]{17}$" type: string 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 errorMessage: type: string description: Error message describing a failure approving the private endpoint request. provider: type: string description: Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only. default: AWS enum: - AWS region: type: string 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 status: type: string description: Status of the private endpoint connection request. enum: - PENDING - OK - FAILED - DELETING type: type: string description: Human-readable label that identifies the resource type associated with this private endpoint. default: DATA_LAKE enum: - DATA_LAKE MesurementsDatabase: type: object properties: databaseName: type: string description: Human-readable label that identifies the database that the specified MongoDB process serves. links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" PaginatedDatabaseView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/MesurementsDatabase" totalCount: minimum: 0 type: integer 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 readOnly: true MeasurementDiskPartition: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" partitionName: type: string description: Human-readable label of the disk or partition to which the measurements apply. readOnly: true PaginatedDiskPartitionView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/MeasurementDiskPartition" totalCount: minimum: 0 type: integer 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 readOnly: true ApiMeasurementsGeneralView_Atlas: type: object properties: databaseName: type: string description: Human-readable label that identifies the database that the specified MongoDB process serves. readOnly: true end: type: string 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 granularity: type: string description: Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**. readOnly: true enum: - PT1M - PT5M - PT1H - P1D groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostId: 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: 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. readOnly: true example: mongodb.example.com:27017 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link_Atlas" measurements: type: array description: List that contains measurements and their data points. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MetricsMeasurement_Atlas" partitionName: type: string description: Human-readable label of the disk or partition to which the measurements apply. readOnly: true processId: 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: 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. readOnly: true example: mongodb.example.com:27017 start: type: string 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 Link_Atlas: type: object properties: href: type: string 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 rel: type: string 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 MetricDataPoint_Atlas: type: object properties: timestamp: type: string 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 value: type: number description: Value that comprises this data point. readOnly: true 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`. readOnly: true MetricsMeasurement_Atlas: type: object properties: dataPoints: type: array 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`. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/MetricDataPoint_Atlas" name: type: string description: Human-readable label of the measurement that this data point covers. readOnly: true units: type: string description: Element used to quantify the measurement. The resource returns units of throughput, storage, and time. readOnly: true enum: - BYTES - BYTES_PER_SECOND - GIGABYTES - GIGABYTES_PER_HOUR - MEGABYTES_PER_SECOND - MICROSECONDS - MILLISECONDS - PERCENT - SCALAR - SCALAR_PER_SECOND ApiHostView_Atlas: type: object properties: created: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. readOnly: true example: 32b6e34b3d91647abb20e7b8 hostname: 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: Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). readOnly: true id: 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: 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. readOnly: true lastPing: type: string 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 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link_Atlas" port: type: integer description: Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests. format: int32 readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set. readOnly: true shardName: type: string description: Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster. readOnly: true typeName: type: string description: Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process. readOnly: true enum: - REPLICA_PRIMARY - REPLICA_SECONDARY - RECOVERING - SHARD_MONGOS - SHARD_CONFIG - SHARD_STANDALONE - SHARD_PRIMARY - SHARD_SECONDARY - NO_DATA userAlias: type: string description: Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter. readOnly: true version: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of MongoDB that this process runs. readOnly: true PaginatedHostView_Atlas: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link_Atlas" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ApiHostView_Atlas" totalCount: minimum: 0 type: integer 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 readOnly: true BackupRestoreJob: required: - delivery type: object properties: batchId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore. readOnly: true example: 32b6e34b3d91647abb20e7b8 checkpointId: pattern: "^([a-f0-9]{24})$" type: string description: |- Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`. Use this parameter with sharded clusters only. - If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**. - If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object. writeOnly: true example: 32b6e34b3d91647abb20e7b8 clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster containing the snapshots you want to retrieve. readOnly: true created: type: string 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 delivery: "$ref": "#/components/schemas/BackupRestoreJobDelivery" encryptionEnabled: type: boolean description: Flag that indicates whether someone encrypted the data in the restored snapshot. readOnly: true groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns the snapshots. readOnly: true example: 32b6e34b3d91647abb20e7b8 hashes: type: array description: 'List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `"methodName" : "HTTP"`, this list contains one object that represents the hash of the **.tar.gz** file.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/RestoreJobFileHash" id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the restore job. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" masterKeyUUID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation oplogInc: minimum: 1 type: integer 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 writeOnly: true oplogTs: 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 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. writeOnly: true pointInTimeUTCMillis: minimum: 1199145600000 type: integer 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**. format: int64 writeOnly: true externalDocs: description: UNIX Epoch url: https://en.wikipedia.org/wiki/Unix_time x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**. example: 32b6e34b3d91647abb20e7b8 statusName: type: string description: Human-readable label that identifies the status of the downloadable file at the time of the request. readOnly: true enum: - IN_PROGRESS - BROKEN - KILLED - FINISHED timestamp: "$ref": "#/components/schemas/ApiBSONTimestampView" BackupRestoreJobDelivery: title: Restore Snapshot Delivery Metadata required: - methodName type: object properties: authHeader: type: string description: 'Header name to use when downloading the restore, used with `"delivery.methodName" : "HTTP"`.' readOnly: true authValue: type: string description: 'Header value to use when downloading the restore, used with `"delivery.methodName" : "HTTP"`.' readOnly: true expirationHours: minimum: 1 type: integer 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 expires: type: string 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 maxDownloads: minimum: 1 type: integer 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 methodName: type: string description: 'Human-readable label that identifies the means for delivering the data. If you set `"delivery.methodName" : "AUTOMATED_RESTORE"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `"delivery.methodName" : "HTTP"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.' enum: - CLIENT_PIT_HTTP - QUERY - AUTOMATED_RESTORE - HTTP - THIRD_PARTY_COPY - CLIENT_PIT_SCP - SCP statusName: type: string description: State of the downloadable snapshot file when MongoDB Cloud received this request. readOnly: true enum: - NOT_STARTED - IN_PROGRESS - READY - FAILED - INTERRUPTED - EXPIRED - MAX_DOWNLOADS_EXCEEDED - PENDING targetClusterId: pattern: "^([a-f0-9]{24})$" type: string description: |- Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`. If the target cluster doesn't have backup enabled, two resources return parameters with empty values: - **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements - **Get a Snapshot** endpoint doesn't return a **clusterId** parameter. To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. example: 32b6e34b3d91647abb20e7b8 targetClusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: |- Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `"delivery.methodName" : "AUTOMATED_RESTORE"`. If the target cluster doesn't have backup enabled, two resources return parameters with empty values: - **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements - **Get a Snapshot** endpoint doesn't return a **clusterId** parameter. To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. targetGroupId: pattern: "^([a-f0-9]{24})$" type: string description: 'Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `"delivery.methodName" : "AUTOMATED_RESTORE"`.' example: 32b6e34b3d91647abb20e7b8 url: type: string 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 deprecated: true urlV2: type: string description: 'Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `"delivery.methodName" : "HTTP"`.' readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation description: Method and details that indicate how to deliver the restored snapshot data. PaginatedRestoreJobView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BackupRestoreJob" totalCount: minimum: 0 type: integer 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 readOnly: true RestoreJobFileHash: type: object properties: fileName: type: string description: Human-readable label that identifies the hashed file. readOnly: true hash: type: string description: Hashed checksum that maps to the restore file. readOnly: true links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" typeName: type: string description: Human-readable label that identifies the hashing algorithm used to compute the hash value. readOnly: true enum: - SHA1 description: Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**. readOnly: true SampleDatasetStatus: type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies this sample dataset. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the cluster into which you loaded the sample dataset. readOnly: true completeDate: type: string 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 createDate: type: string 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 errorMessage: type: string 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 state: type: string description: Status of the sample dataset load job. readOnly: true enum: - WORKING - FAILED - COMPLETED ServerlessBackupRestoreJob: required: - deliveryType - targetClusterName - targetGroupId type: object properties: cancelled: type: boolean description: Flag that indicates whether someone canceled this restore job. readOnly: true deliveryType: type: string description: Human-readable label that categorizes the restore job to create. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - automated - download - pointInTime deliveryUrl: type: array 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"`.' readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. desiredTimestamp: "$ref": "#/components/schemas/ApiBSONTimestampView" expired: type: boolean description: Flag that indicates whether the restore job expired. readOnly: true expiresAt: type: string 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 failed: type: boolean description: Flag that indicates whether the restore job failed. readOnly: true finishedAt: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the restore job. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" oplogInc: minimum: 1 type: integer 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`.' format: int32 example: 1 oplogTs: minimum: 1199145600 type: integer 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 pointInTimeUTCSeconds: minimum: 1199145600 type: integer 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal character string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 targetClusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string 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"`. targetGroupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. example: 32b6e34b3d91647abb20e7b8 timestamp: type: string 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 PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ServerlessBackupRestoreJob" totalCount: minimum: 0 type: integer 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 readOnly: true ServerlessBackupSnapshot: type: object properties: createdAt: type: string 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 expiresAt: type: string 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 frequencyType: type: string description: Human-readable label that identifies how often this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - hourly - daily - weekly - monthly id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mongodVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Version of the MongoDB host that this snapshot backs up. readOnly: true serverlessInstanceName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot. readOnly: true snapshotType: type: string description: Human-readable label that identifies when this snapshot triggers. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - onDemand - scheduled status: type: string description: Human-readable label that indicates the stage of the backup process for this snapshot. readOnly: true x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - queued - inProgress - completed - failed storageSizeBytes: type: integer description: Number of bytes taken to store the backup snapshot. format: int64 readOnly: true PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/ServerlessBackupSnapshot" totalCount: minimum: 0 type: integer 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 readOnly: true ServerlessAWSTenantEndpoint: title: AWS type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the private endpoint. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation cloudProviderEndpointId: pattern: "^vpce-[0-9a-f]{17}$" type: string description: Unique string that identifies the private endpoint's network interface. readOnly: true comment: maxLength: 80 type: string description: Human-readable comment associated with the private endpoint. readOnly: true endpointServiceName: pattern: "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}" type: string description: Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. readOnly: true errorMessage: type: string description: Human-readable error message that indicates error condition associated with establishing the private endpoint connection. readOnly: true providerName: type: string description: Human-readable label that identifies the cloud service provider. readOnly: true enum: - AWS status: type: string description: Human-readable label that indicates the current operating status of the private endpoint. readOnly: true enum: - RESERVATION_REQUESTED - RESERVED - INITIATING - AVAILABLE - FAILED - DELETING description: View for a serverless AWS tenant endpoint. ServerlessAzureTenantEndpoint: title: Azure type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the private endpoint. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation cloudProviderEndpointId: 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 description: Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service. readOnly: true comment: maxLength: 80 type: string description: Human-readable comment associated with the private endpoint. readOnly: true endpointServiceName: pattern: "^pls_[0-9a-f]{24}$" type: string description: Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service. readOnly: true errorMessage: type: string description: Human-readable error message that indicates error condition associated with establishing the private endpoint connection. readOnly: true privateEndpointIpAddress: 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: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. readOnly: true privateLinkServiceResourceId: type: string 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 providerName: type: string description: Human-readable label that identifies the cloud service provider. readOnly: true enum: - AZURE status: type: string description: Human-readable label that indicates the current operating status of the private endpoint. readOnly: true enum: - RESERVATION_REQUESTED - RESERVED - INITIATING - AVAILABLE - FAILED - DELETING description: View for a serverless Azure tenant endpoint. ServerlessTenantEndpoint: type: object properties: _id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the private endpoint. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation cloudProviderEndpointId: type: string description: Unique string that identifies the private endpoint's network interface. readOnly: true comment: maxLength: 80 type: string description: Human-readable comment associated with the private endpoint. readOnly: true endpointServiceName: pattern: "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$" type: string description: Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. readOnly: true errorMessage: type: string description: Human-readable error message that indicates error condition associated with establishing the private endpoint connection. readOnly: true status: type: string description: Human-readable label that indicates the current operating status of the private endpoint. readOnly: true enum: - RESERVATION_REQUESTED - RESERVED - INITIATING - AVAILABLE - FAILED - DELETING x-xgen-IPA-exception: xgen-IPA-125-oneOf-must-have-discriminator: Schema predates IPA validation oneOf: - "$ref": "#/components/schemas/ServerlessAWSTenantEndpoint" - "$ref": "#/components/schemas/ServerlessAzureTenantEndpoint" ServerlessTenantCreateRequest: type: object properties: comment: maxLength: 80 type: string description: Human-readable comment associated with the private endpoint. writeOnly: true ServerlessAWSTenantEndpointUpdate: title: AWS required: - providerName type: object description: Updates to a serverless AWS tenant endpoint. allOf: - "$ref": "#/components/schemas/ServerlessTenantEndpointUpdate" - type: object properties: cloudProviderEndpointId: pattern: "^vpce-[0-9a-f]{17}$" type: string description: Unique string that identifies the private endpoint's network interface. writeOnly: true ServerlessAzureTenantEndpointUpdate: title: AZURE required: - providerName type: object description: Updates to a serverless Azure tenant endpoint. allOf: - "$ref": "#/components/schemas/ServerlessTenantEndpointUpdate" - type: object properties: cloudProviderEndpointId: 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 description: Unique string that identifies the Azure private endpoint's network interface for this private endpoint service. writeOnly: true privateEndpointIpAddress: 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: IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. writeOnly: true ServerlessTenantEndpointUpdate: required: - providerName type: object properties: comment: maxLength: 80 type: string description: Human-readable comment associated with the private endpoint. writeOnly: true providerName: type: string description: Human-readable label that identifies the cloud provider of the tenant endpoint. writeOnly: true enum: - AWS - AZURE description: Update view for a serverless tenant endpoint. discriminator: propertyName: providerName mapping: AWS: "#/components/schemas/ServerlessAWSTenantEndpointUpdate" AZURE: "#/components/schemas/ServerlessAzureTenantEndpointUpdate" ApiAtlasSnapshotScheduleView: required: - clusterCheckpointIntervalMin - clusterId - dailySnapshotRetentionDays - groupId - monthlySnapshotRetentionMonths - pointInTimeWindowHours - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks type: object properties: clusterCheckpointIntervalMin: type: integer 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. format: int32 enum: - 15 - 30 - 60 clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. example: 32b6e34b3d91647abb20e7b8 dailySnapshotRetentionDays: type: integer 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. format: int32 enum: - 0 - 3 - 4 - 5 - 6 - 7 - 15 - 30 - 60 - 90 - 120 - 180 - 360 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that contains the cluster. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" monthlySnapshotRetentionMonths: type: integer description: Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention. format: int32 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 18 - 24 - 36 pointInTimeWindowHours: type: integer description: Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot. format: int32 snapshotIntervalHours: type: integer description: Number of hours that must elapse before taking another snapshot. format: int32 enum: - 6 - 8 - 12 - 24 snapshotRetentionDays: type: integer description: Number of days that MongoDB Cloud must keep recent snapshots. format: int32 enum: - 2 - 3 - 4 - 5 weeklySnapshotRetentionWeeks: type: integer description: Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention. format: int32 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 12 - 16 - 20 - 24 - 52 BackupSnapshot: type: object properties: clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return. readOnly: true example: 32b6e34b3d91647abb20e7b8 clusterName: type: string description: Human-readable label that identifies the cluster. readOnly: true complete: type: boolean description: Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot. readOnly: true created: "$ref": "#/components/schemas/ApiBSONTimestampView" doNotDelete: type: boolean description: 'Flag that indicates whether someone can delete this snapshot. You can''t set `"doNotDelete" : true` and set a timestamp for **expires** in the same request.' expires: type: string 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 groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that owns the snapshots. readOnly: true example: 32b6e34b3d91647abb20e7b8 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot. readOnly: true example: 32b6e34b3d91647abb20e7b8 incremental: type: boolean description: Flag indicating if this is an incremental or a full snapshot. readOnly: true lastOplogAppliedTimestamp: "$ref": "#/components/schemas/ApiBSONTimestampView" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" parts: type: array description: |- Metadata that describes the complete snapshot. - For a replica set, this array contains a single document. - For a sharded cluster, this array contains one document for each shard plus one document for the config host. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BackupSnapshotPart" BackupSnapshotPart: title: Snapshot Components type: object properties: clusterId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return. readOnly: true example: 32b6e34b3d91647abb20e7b8 completedTime: type: string 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 compressionSetting: type: string description: Human-readable label that identifies the method of compression for the snapshot. readOnly: true enum: - NONE - GZIP dataSizeBytes: type: integer description: Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes. format: int64 readOnly: true encryptionEnabled: type: boolean description: Flag that indicates whether someone encrypted this snapshot. readOnly: true fcv: type: string description: Number that indicates the feature compatibility version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot. readOnly: true fileSizeBytes: type: integer description: Number that indicates the total size of the data files in bytes. format: int64 readOnly: true machineId: 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: Hostname and port that indicate the node on which MongoDB Cloud created the snapshot. readOnly: true masterKeyUUID: type: string 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 x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation mongodVersion: pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" type: string description: Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot. readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set. readOnly: true replicaState: type: string description: The node's role at the time when snapshot process began. readOnly: true storageSizeBytes: type: integer description: Number that indicates the total size of space allocated for document storage. format: int64 readOnly: true typeName: type: string description: Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot. readOnly: true enum: - REPLICA_SET - CONFIG_SERVER - CONFIG_SERVER_REPLICA_SET - CONFIG_SHARD_REPLICA_SET description: Characteristics that identify this snapshot. readOnly: true PaginatedSnapshotView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BackupSnapshot" totalCount: minimum: 0 type: integer 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 readOnly: true TenantRestore: required: - snapshotId - targetDeploymentItemName type: object properties: clusterName: pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" type: string description: Human-readable label that identifies the source cluster. readOnly: true deliveryType: type: string description: Means by which this resource returns the snapshot to the requesting MongoDB Cloud user. readOnly: true enum: - RESTORE - DOWNLOAD expirationDate: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the restore job. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" projectId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project from which the restore job originated. readOnly: true example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-avoid-project-field-names: Schema predates IPA validation restoreFinishedDate: type: string 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 restoreScheduledDate: type: string 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 snapshotFinishedDate: type: string 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 snapshotId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the snapshot to restore. example: 32b6e34b3d91647abb20e7b8 snapshotUrl: type: string description: 'Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `"deliveryType" : "DOWNLOAD"`.' readOnly: true status: type: string description: Phase of the restore workflow for this job at the time this resource made this request. readOnly: true enum: - PENDING - QUEUED - RUNNING - FAILED - COMPLETED targetDeploymentItemName: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" type: string description: Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater. targetProjectId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot. example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-avoid-project-field-names: Schema predates IPA validation PaginatedTenantRestoreView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/TenantRestore" totalCount: minimum: 0 type: integer 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 readOnly: true BackupTenantSnapshot: type: object properties: expiration: type: string 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 finishTime: type: string 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 id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the restore job. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" mongoDBVersion: type: string description: MongoDB host version that the snapshot runs. readOnly: true x-xgen-IPA-exception: xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation scheduledTime: type: string 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 startTime: type: string 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 status: type: string description: Phase of the workflow for this snapshot at the time this resource made this request. readOnly: true enum: - PENDING - QUEUED - RUNNING - FAILED - COMPLETED PaginatedTenantSnapshotView: type: object properties: links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" results: type: array description: List of returned documents that MongoDB Cloud provides when completing this request. readOnly: true items: "$ref": "#/components/schemas/BackupTenantSnapshot" totalCount: minimum: 0 type: integer 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 readOnly: true LDAPVerifyConnectivityJobRequest: type: object properties: groupId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" request: "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" requestId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration. readOnly: true example: 32b6e34b3d91647abb20e7b8 status: type: string description: Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. readOnly: true enum: - FAIL - PENDING - SUCCESS validations: type: array 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. readOnly: true x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" LDAPVerifyConnectivityJobRequestParams: required: - bindPassword - bindUsername - hostname - port type: object properties: authzQueryTemplate: type: string 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). writeOnly: true example: "{USER}?memberOf?base" x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one default: "{USER}?memberOf?base" bindPassword: type: string description: Password that MongoDB Cloud uses to authenticate the **bindUsername**. writeOnly: true bindUsername: pattern: "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" type: string 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 caCertificate: type: string 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": ""`.' hostname: 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 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. links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" port: type: integer description: IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. format: int32 default: 636 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**. LDAPVerifyConnectivityJobRequestValidation: type: object properties: status: type: string description: Human-readable string that indicates the result of this verification test. readOnly: true enum: - FAIL - OK validationType: type: string description: Human-readable label that identifies this verification test that MongoDB Cloud runs. readOnly: true enum: - AUTHENTICATE - AUTHORIZATION_ENABLED - CONNECT - PARSE_AUTHZ_QUERY - QUERY_SERVER - SERVER_SPECIFIED - TEMPLATE 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. readOnly: true DBUserTLSX509Settings: title: Database User TLS Certificate Settings type: object properties: cas: type: string description: Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate. links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" description: Settings to configure TLS Certificates for database users. LDAPSecuritySettings: title: LDAP Security Settings type: object properties: authenticationEnabled: type: boolean description: Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host. authorizationEnabled: type: boolean description: Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host. authzQueryTemplate: type: string 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" x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one default: "{USER}?memberOf?base" bindPassword: type: string description: Password that MongoDB Cloud uses to authenticate the **bindUsername**. writeOnly: true bindUsername: pattern: "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" type: string 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 caCertificate: type: string 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": ""`.' hostname: 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 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. links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" port: type: integer description: Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. format: int32 default: 636 userToDNMapping: type: array description: User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation xgen-IPA-112-field-names-are-camel-case: Schema predates IPA validation items: "$ref": "#/components/schemas/UserToDNMapping" description: Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project. UserSecurity: type: object properties: customerX509: "$ref": "#/components/schemas/DBUserTLSX509Settings" ldap: "$ref": "#/components/schemas/LDAPSecuritySettings" links: type: array description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. readOnly: true externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: "$ref": "#/components/schemas/Link" UserToDNMapping: title: User to Distinguished Name Mapping required: - match type: object properties: ldapQuery: type: string 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). x-xgen-IPA-exception: xgen-IPA-117-description-should-not-use-inline-links: Description has multiple links, and externalDocs only supports one match: type: string 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: "(.*)" substitution: type: string 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 description: User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN. BackupComplianceOnDemandPolicyItem: required: - frequencyInterval - frequencyType - retentionUnit - retentionValue type: object properties: frequencyInterval: type: integer 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. format: int32 x-xgen-IPA-exception: xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 40 frequencyType: type: string description: Human-readable label that identifies the frequency type associated with the backup policy. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - ondemand id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this backup policy item. readOnly: true example: 32b6e34b3d91647abb20e7b8 retentionUnit: type: string description: Unit of time in which MongoDB Cloud measures snapshot retention. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - days - weeks - months - years retentionValue: type: integer 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 description: Specifications for on-demand policy. BackupComplianceScheduledPolicyItem: required: - frequencyInterval - frequencyType - retentionUnit - retentionValue type: object properties: frequencyInterval: type: integer 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. format: int32 x-xgen-IPA-exception: xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 40 frequencyType: type: string description: Human-readable label that identifies the frequency type associated with the backup policy. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - daily - hourly - weekly - monthly - yearly id: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies this backup policy item. readOnly: true example: 32b6e34b3d91647abb20e7b8 retentionUnit: type: string description: Unit of time in which MongoDB Cloud measures Snapshot retention. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - days - weeks - months - years retentionValue: type: integer 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 description: Specifications for scheduled policy. DataProtectionSettings: required: - authorizedEmail type: object properties: authorizedEmail: type: string description: Email address of the user who authorized to update the Backup Compliance Policy settings. format: email authorizedUserFirstName: type: string description: First name of the user who authorized to update the Backup Compliance Policy settings. authorizedUserLastName: type: string description: Last name of the user who authorized to update the Backup Compliance Policy settings. copyProtectionEnabled: type: boolean 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. default: false deletable: type: boolean 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. readOnly: true externalDocs: description: Configure a Backup Compliance Policy url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/ default: false encryptionAtRestEnabled: type: boolean 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/ default: false onDemandPolicyItem: "$ref": "#/components/schemas/BackupComplianceOnDemandPolicyItem" pitEnabled: type: boolean 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/ default: false projectId: pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy. example: 32b6e34b3d91647abb20e7b8 x-xgen-IPA-exception: xgen-IPA-112-avoid-project-field-names: Schema predates IPA validation restoreWindowDays: type: integer 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 scheduledPolicyItems: type: array description: List that contains the specifications for one scheduled policy. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: "$ref": "#/components/schemas/BackupComplianceScheduledPolicyItem" state: type: string 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. readOnly: true enum: - ACTIVE - ENABLING - UPDATING - DISABLING updatedDate: type: string 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 updatedUser: type: string 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 ApiAtlasFTSAnalyzersViewManual: title: analyzers required: - name - tokenizer type: object properties: name: type: string description: |- Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings: - `lucene.` - `builtin.` - `mongodb.` x-xgen-IPA-exception: xgen-IPA-117-description-ends-with-period: Description ends with an item list charFilters: type: array description: Filters that examine text one character at a time and perform filtering operations. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: object oneOf: - "$ref": "#/components/schemas/charFilterhtmlStrip" - "$ref": "#/components/schemas/charFiltericuNormalize" - "$ref": "#/components/schemas/charFiltermapping" - "$ref": "#/components/schemas/charFilterpersian" tokenizer: type: object description: Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing. discriminator: propertyName: type 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" 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" tokenFilters: type: array description: |- Filter that performs operations such as: - Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk". - Redaction, the removal of sensitive information from public documents. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation 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" description: Settings that describe one Atlas Search custom analyzer. charFilterhtmlStrip: title: htmlStrip required: - type type: object properties: type: type: string description: Human-readable label that identifies this character filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - htmlStrip ignoredTags: type: array description: The HTML tags that you want to exclude from filtering. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string description: Filter that strips out HTML constructs. charFiltericuNormalize: title: icuNormalize required: - type type: object properties: type: type: string description: Human-readable label that identifies this character filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - icuNormalize 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 charFiltermapping: title: mapping required: - mappings - type type: object properties: type: type: string description: Human-readable label that identifies this character filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - mapping mappings: type: object 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: ` : `. description: Filter that applies normalization mappings that you specify to characters. charFilterpersian: title: persian required: - type type: object properties: type: type: string description: Human-readable label that identifies this character filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - persian 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 tokenizernGram: title: nGram required: - maxGram - minGram - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - edgeGram minGram: type: integer description: Characters to include in the shortest token that Atlas Search creates. maxGram: type: integer description: Characters to include in the longest token that Atlas Search creates. 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. tokenizeredgeGram: title: edgeGram required: - maxGram - minGram - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - edgeGram minGram: type: integer description: Characters to include in the shortest token that Atlas Search creates. maxGram: type: integer description: Characters to include in the longest token that Atlas Search creates. 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. tokenizerkeyword: title: keyword required: - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - keyword description: Tokenizer that combines the entire input as a single token. tokenizerregexCaptureGroup: title: regexCaptureGroup required: - group - pattern - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - regexCaptureGroup pattern: type: string description: Regular expression to match against. group: type: integer description: Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups. description: Tokenizer that uses a regular expression pattern to extract tokens. tokenizerregexSplit: title: regexSplit required: - pattern - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - regexSplit pattern: type: string description: Regular expression to match against. description: Tokenizer that splits tokens using a regular-expression based delimiter. tokenizerstandard: title: standard required: - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - standard maxTokenLength: type: integer description: Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. default: 255 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 tokenizeruaxUrlEmail: title: uaxUrlEmail required: - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - uaxUrlEmail maxTokenLength: type: integer description: Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. default: 255 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 tokenizerwhitespace: title: whitespace required: - type type: object properties: type: type: string description: Human-readable label that identifies this tokenizer type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - whitespace maxTokenLength: type: integer description: Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. default: 255 description: Tokenizer that creates tokens based on occurrences of whitespace between words. tokenFilterasciiFolding: title: asciiFolding required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - asciiFolding originalTokens: type: string 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. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: omit enum: - omit - include 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) tokenFilterdaitchMokotoffSoundex: title: daitchMokotoffSoundex required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - daitchMokotoffSoundex originalTokens: type: string 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. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: include enum: - omit - include 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 tokenFilteredgeGram: title: edgeGram required: - maxGram - minGram - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - edgeGram minGram: type: integer description: Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**. maxGram: type: integer description: Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**. termNotInBounds: type: string description: Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: omit enum: - omit - include 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. TokenFilterEnglishPossessive: title: englishPossessive required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - englishPossessive description: Filter that removes possessives (trailing 's) from words. TokenFilterFlattenGraph: title: flattenGraph required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - flattenGraph 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. tokenFiltericuFolding: title: icuFolding required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - icuFolding 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 tokenFiltericuNormalizer: title: icuNormalizer required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - icuNormalizer normalizationForm: type: string description: Normalization form to apply. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: nfc enum: - nfd - nfc - nfkd - nfkc description: Filter that normalizes tokens using a standard Unicode Normalization Mode. externalDocs: description: Unicode Normalization Mode url: https://unicode.org/reports/tr15/ TokenFilterkStemming: title: kStemming required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - kStemming description: Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words. tokenFilterlength: title: length required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - length min: type: integer description: Number that specifies the minimum length of a token. This value must be less than or equal to **max**. default: 0 max: type: integer description: Number that specifies the maximum length of a token. Value must be greater than or equal to **min**. default: 255 description: Filter that removes tokens that are too short or too long. tokenFilterlowercase: title: lowercase required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - lowercase description: Filter that normalizes token text to lowercase. tokenFilternGram: title: nGram required: - maxGram - minGram - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - nGram minGram: type: integer description: Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**. maxGram: type: integer description: Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**. termNotInBounds: type: string description: Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation default: omit enum: - omit - include description: Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions. TokenFilterPorterStemming: title: porterStemming required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - porterStemming 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. tokenFilterregex: title: regex required: - matches - pattern - replacement - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - regex pattern: type: string description: Regular expression pattern to apply to each token. replacement: type: string description: Replacement string to substitute wherever a matching pattern occurs. matches: type: string description: Value that indicates whether to replace only the first matching pattern or all matching patterns. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - all - first description: Filter that applies a regular expression to each token, replacing matches with a specified string. tokenFilterreverse: title: reverse required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - reverse description: Filter that reverses each string token. tokenFiltershingle: title: shingle required: - maxShingleSize - minShingleSize - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - shingle minShingleSize: type: integer description: Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**. maxShingleSize: type: integer description: Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**. 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. tokenFiltersnowballStemming: title: snowballStemming required: - stemmerName - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - snowballStemming stemmerName: type: string description: Snowball-generated stemmer to use. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation xgen-IPA-123-allowable-enum-values-should-not-exceed-20: Schema predates IPA validation 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 description: Filter that stems tokens using a Snowball-generated stemmer. externalDocs: description: Snowball-generated stemmer url: https://snowballstem.org/ TokenFilterSpanishPluralStemming: title: spanishPluralStemming required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - spanishPluralStemming description: Filter that stems Spanish plural words. It expects lowercase text. TokenFilterStempel: title: stempel required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - stempel 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 tokenFilterstopword: title: stopword required: - tokens - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - stopword tokens: type: array description: The stop words that correspond to the tokens to remove. Value must be one or more stop words. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string ignoreCase: type: boolean description: Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove. default: true description: Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify. tokenFiltertrim: title: trim required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - trim description: Filter that trims leading and trailing whitespace from tokens. TokenFilterWordDelimiterGraph: title: wordDelimiterGraph required: - type type: object properties: type: type: string description: Human-readable label that identifies this token filter type. x-xgen-IPA-exception: xgen-IPA-123-enum-values-must-be-upper-snake-case: Schema predates IPA validation enum: - wordDelimiterGraph delimiterOptions: type: object properties: generateWordParts: type: boolean description: Flag that indicates whether to split tokens based on sub-words. default: true generateNumberParts: type: boolean 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`. default: true concatenateWords: type: boolean description: Flag that indicates whether to concatenate runs of sub-words. default: false concatenateNumbers: type: boolean description: Flag that indicates whether to concatenate runs of sub-numbers. default: false concatenateAll: type: boolean description: Flag that indicates whether to concatenate runs. default: false preserveOriginal: type: boolean description: Flag that indicates whether to generate tokens of the original words. default: true splitOnCaseChange: type: boolean description: Flag that indicates whether to split tokens based on letter-case transitions. default: true splitOnNumerics: type: boolean description: Flag that indicates whether to split tokens based on letter-number transitions. default: true stemEnglishPossessive: type: boolean description: Flag that indicates whether to remove trailing possessives from each sub-word. default: true ignoreKeywords: type: boolean description: Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`. default: false description: Object that contains the rules that determine how to split words into sub-words. protectedWords: required: - words type: object properties: words: type: array description: List that contains the tokens to protect from delimination. x-xgen-IPA-exception: xgen-IPA-124-array-max-items: Schema predates IPA validation items: type: string ignoreCase: type: boolean description: Flag that indicates whether to ignore letter case sensitivity for protected words. default: true description: Object that contains options for protected words. description: Filter that splits tokens into sub-tokens based on configured rules. DataLakeStorage: type: object properties: databases: type: array description: Array that contains the queryable databases and collections for this data lake. items: "$ref": "#/components/schemas/DataLakeDatabaseInstance" stores: type: array description: Array that contains the data stores for the data lake. items: "$ref": "#/components/schemas/DataLakeStoreSettings" description: Configuration information for each data store and its mapping to MongoDB Cloud databases. DataLakeDatabaseInstance: type: object properties: collections: type: array description: Array of collections and data sources that map to a ``stores`` data store. items: "$ref": "#/components/schemas/DataLakeDatabaseCollection" maxWildcardCollections: maximum: 1000 minimum: 1 type: integer description: Maximum number of wildcard collections in the database. This only applies to S3 data sources. format: int32 default: 100 name: type: string description: Human-readable label that identifies the database to which the data lake maps data. views: type: array description: Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources. items: "$ref": "#/components/schemas/DataLakeApiBase" description: Database associated with this data lake. Databases contain collections and views. DataLakeDatabaseCollection: type: object properties: dataSources: type: array description: Array that contains the data stores that map to a collection for this data lake. items: "$ref": "#/components/schemas/DataLakeDatabaseDataSourceSettings" name: type: string description: Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores. description: A collection and data sources that map to a ``stores`` data store. DataLakeDatabaseDataSourceSettings: type: object properties: allowInsecure: type: boolean 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. default: false collection: type: string description: Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter. collectionRegex: type: string 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). database: type: string 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. databaseRegex: type: string 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). datasetName: type: string 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 datasetPrefix: type: string description: Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives. defaultFormat: type: string 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" path: type: string 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. provenanceFieldName: type: string 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. storeName: type: string description: Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. trimLevel: type: integer 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 urls: type: array 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 description: Data store that maps to a collection for this data lake. DataLakeApiBase: type: object properties: name: type: string description: Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. pipeline: type: string description: Aggregation pipeline stages to apply to the source collection. externalDocs: description: Aggregation Pipelines url: https://docs.mongodb.com/manual/core/aggregation-pipeline/ source: type: string description: Human-readable label that identifies the source collection for the view. description: An aggregation pipeline that applies to the collection. DataLakeStoreSettings: required: - provider type: object properties: name: type: string 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. provider: type: string description: Group of settings that define where the data is stored. discriminator: propertyName: provider mapping: s3: "#/components/schemas/DataLakeS3StoreSettings" dls:aws: "#/components/schemas/DataLakeDLSAWSStore" dls:azure: "#/components/schemas/DataLakeDLSAzureStore" dls:gcp: "#/components/schemas/DataLakeDLSGCPStore" atlas: "#/components/schemas/DataLakeAtlasStoreInstance" http: "#/components/schemas/DataLakeHTTPStore" azure: "#/components/schemas/DataLakeAzureBlobStore" gcs: "#/components/schemas/DataLakeGoogleCloudStorageStore" 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" DataLakeS3StoreSettings: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: additionalStorageClasses: type: array 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: type: string 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 bucket: type: string 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. delimiter: type: string 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 `/`. includeTags: type: boolean 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. default: false prefix: type: string 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. public: type: boolean 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. default: false region: title: AWS 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_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 DataLakeDLSAWSStore: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: region: title: AWS 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_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 DataLakeDLSAzureStore: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: region: title: Azure 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_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 DataLakeAtlasStoreInstance: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: clusterName: type: string description: Human-readable label of the MongoDB Cloud cluster on which the store is based. projectId: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" type: string description: Unique 24-hexadecimal digit string that identifies the project. readOnly: true readConcern: "$ref": "#/components/schemas/DataLakeAtlasStoreReadConcern" readPreference: "$ref": "#/components/schemas/DataLakeAtlasStoreReadPreference" DataLakeAtlasStoreReadConcern: type: object properties: level: type: string description: Read Concern level that specifies the consistency and availability of the data read. externalDocs: description: Read Concern Level url: https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels enum: - LOCAL - MAJORITY - LINEARIZABLE - SNAPSHOT - AVAILABLE description: MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster. DataLakeAtlasStoreReadPreference: type: object properties: maxStalenessSeconds: type: integer description: Maximum replication lag, or **staleness**, for reads from secondaries. format: int32 mode: type: string description: Read preference mode that specifies to which replica set member to route the read requests. externalDocs: description: Read Preference Modes url: https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes enum: - primary - primaryPreferred - secondary - secondaryPreferred - nearest tagSets: type: array 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: type: array items: "$ref": "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" description: MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster. DataLakeAtlasStoreReadPreferenceTag: type: object properties: name: type: string description: Human-readable label of the tag. value: type: string description: Value of the tag. DataLakeHTTPStore: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: allowInsecure: type: boolean 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. default: false defaultFormat: type: string 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. urls: type: array description: Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication. items: type: string description: Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication. DataLakeAzureBlobStore: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: containerName: type: string description: Human-readable label that identifies the name of the container. delimiter: type: string description: Delimiter. prefix: type: string description: Prefix. public: type: boolean 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. default: false region: title: Azure 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_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 replacementDelimiter: type: string description: Replacement Delimiter. serviceURL: type: string description: Service URL. DataLakeGoogleCloudStorageStore: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: bucket: type: string description: Human-readable label that identifies the Google Cloud Storage bucket. delimiter: type: string description: Delimiter. prefix: type: string description: Prefix. public: type: boolean 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. default: false region: title: GCP Regions type: string 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 replacementDelimiter: type: string description: Replacement Delimiter. DataLakeDLSGCPStore: type: object allOf: - "$ref": "#/components/schemas/DataLakeStoreSettings" - type: object properties: region: title: GCP Regions type: string 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 responses: accepted: description: Accepted. badRequest: description: Bad Request. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 400 reason: Bad Request errorCode: VALIDATION_ERROR detail: "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists." notFound: description: Not Found. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 404 reason: Not Found errorCode: RESOURCE_NOT_FOUND detail: "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS" conflict: description: Conflict. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 409 reason: Conflict errorCode: CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK 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" noBody: description: This endpoint does not return a response body. unauthorized: description: Unauthorized. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 401 reason: Unauthorized errorCode: NOT_ORG_GROUP_CREATOR detail: "(This is just an example, the exception may not be related to this endpoint)" gone: description: Gone. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 410 reason: Gone errorCode: VERSION_GONE detail: This happens when a resource is marked for sunset and the sunset date is in the past. paymentRequired: description: Payment Required. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 402 reason: Payment Required errorCode: NO_PAYMENT_INFORMATION_FOUND detail: "(This is just an example, the exception may not be related to this endpoint)" forbidden: description: Forbidden. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 403 reason: Forbidden errorCode: CANNOT_CHANGE_GROUP_NAME detail: "(This is just an example, the exception may not be related to this endpoint)" methodNotAllowed: description: Method Not Allowed. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 405 reason: Method Not Allowed errorCode: ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED detail: "(This is just an example, the exception may not be related to this endpoint)" tooManyRequests: description: Too Many Requests. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 429 reason: Too Many Requests errorCode: RATE_LIMITED detail: "(This is just an example, the exception may not be related to this endpoint)" internalServerError: description: Internal Server Error. content: application/json: schema: "$ref": "#/components/schemas/ApiError" example: error: 500 reason: Internal Server Error errorCode: UNEXPECTED_ERROR detail: "(This is just an example, the exception may not be related to this endpoint)" parameters: envelope: name: envelope in: query 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. required: false schema: type: boolean default: false pretty: name: pretty in: query description: Flag that indicates whether the response body should be in the prettyprint format. required: false schema: type: boolean externalDocs: description: Prettyprint url: https://en.wikipedia.org/wiki/Prettyprint default: false orgId: name: orgId in: path 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. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 4888442a3354817a7320eb61 federationSettingsId: name: federationSettingsId in: path description: Unique 24-hexadecimal digit string that identifies your federation. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 55fa922fb343282757d9554e identityProviderId: name: identityProviderId in: path 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. required: true schema: pattern: "^([a-f0-9]{20})$" type: string example: c2777a9eca931f29fc2f groupId: name: groupId in: path 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. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 32b6e34b3d91647abb20e7b8 processId: name: processId in: path 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. 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 example: my.host.name.com:27017 liveMigrationId: name: liveMigrationId in: path description: Unique 24-hexadecimal digit string that identifies the migration. required: true schema: pattern: "^([a-f0-9]{24})$" type: string example: 6296fb4c7c7aa997cf94e9a8 databaseName: name: databaseName in: path description: Human-readable label that identifies the database. required: true schema: type: string example: mydb collectionName: name: collectionName in: path description: Human-readable label that identifies the collection. required: true schema: type: string example: mycoll indexName: name: indexName in: path description: Human-readable label that identifies the index. required: true schema: type: string example: myindex includeCount: name: includeCount in: query description: Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. required: false schema: type: boolean default: true itemsPerPage: name: itemsPerPage in: query description: Number of items that the response returns per page. required: false schema: maximum: 500 minimum: 1 type: integer default: 100 pageNum: name: pageNum in: query description: Number of the page that displays the current set of the total objects that the response returns. required: false schema: minimum: 1 type: integer default: 1 granularity: name: granularity in: query 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. required: true schema: type: string example: PT1M period: name: period in: query 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**. required: false schema: type: string example: PT10H start: name: start in: query 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**. required: false schema: type: string format: date-time end: name: end in: query 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**. required: false schema: type: string format: date-time securitySchemes: ServiceAccounts: type: oauth2 description: Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview). flows: clientCredentials: tokenUrl: https://cloud.mongodb.com/api/oauth/token scopes: {} DigestAuth: type: http scheme: digest